Command Line Interface
The storageos
command line interface (CLI) is used to manage cluster-wide
configuration.
Installation
# linux/amd64
curl -sSLo storageos https://github.com/storageos/go-cli/releases/download/1.0.0/storageos_linux_amd64 && chmod +x storageos && sudo mv storageos /usr/local/bin/
# OS X/amd64
curl -sSLo storageos https://github.com/storageos/go-cli/releases/download/1.0.0/storageos_darwin_amd64 && chmod +x storageos && sudo mv storageos /usr/local/bin/
You will need to provide the correct credentials to connect to the API. The
default installation creates a single user with username storageos
and
password storageos
:
# Use environment variables
export STORAGEOS_USERNAME=storageos STORAGEOS_PASSWORD=storageos
# Access StorageOS running on a remote host by providing the IP address
export STORAGEOS_HOST=10.1.5.249
Usage
$ storageos
Usage: storageos COMMAND
Converged storage for containers.
By using this product, you are agreeing to the terms of the the StorageOS Ltd. End
User Subscription Agreement (EUSA) found at: https://storageos.com/legal/#eusa
Options:
--config string Location of client config files (default "/Users/<user>/.storageos")
-D, --debug Enable debug mode
--help Print usage
-H, --host list Node endpoint(s) to connect to (will override STORAGEOS_HOST env variable value)
(default [])
-p, --password string API password (will override STORAGEOS_PASSWORD env variable value)
-u, --username string API username (will override STORAGEOS_USERNAME env variable value)
-v, --version Print version information and quit
Management Commands:
cluster Manage clusters
logs View and manage node logs
namespace Manage namespaces
node Manage nodes
policy Manage policies
pool Manage capacity pools
rule Manage rules
user Manage users
volume Manage volumes
Commands:
install-bash-completion Install bash completion for the storageos CLI
login Store login credentials for a given storageos host
logout Delete stored login credentials for a given storageos host
version Show the StorageOS version information
Run 'storageos COMMAND --help' for more information on a command.
Cheatsheet
Command | Subcommand | Description |
---|---|---|
cluster |
create health inspect rm |
Cluster information. |
logs |
view |
View and manage node logs. |
login |
Store login credentials for a given StorageOS host. | |
logout |
Delete stored login credentials for a given StorageOS host. | |
namespace |
create inspect ls rm update |
Namespaces help different projects or teams organize volumes. |
node |
cordon drain health inspect ls uncordon undrain update |
Node information. |
policy |
create inspect ls rm |
Define how resources are accessed by users and groups. |
pool |
create inspect ls rm |
A collection of storage resources for provisioning volumes. |
rule |
create inspect ls rm update |
Rules define label-based policies to apply to volumes. |
user |
create inspect ls rm update |
User and group management. |
version |
Display the version. | |
volume |
create inspect ls rm update |
StorageOS data volumes. |