+ CLI Guide Overview

From OSNEXUS Online Documentation Site
Revision as of 18:00, 1 July 2011 by Qadmin (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems remotely via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of resources. The command line utility for managing your QuantaStor system is called simply 'qs'. You can run 'qs' after logging into your QuantaStor system via an SSH connection, or you can download the QuantaStor Remote CLI client installer for Windows which is available for download from the web site.

[How to use the CLI]

   qs command -mandatory-arg=val [-optional-arg=val] [-flags=force,async,...] [-xml] [-min]

XML Output Mode Use --xml with any command to get the results in XML. Minimal Output Mode Use --min with any list or enumeration command where you want the results in a more compact format. Interactive Mode You can use the qs command line utility in an interactive mode where you will not have to run it from the shell each time. To enter the interactive mode just run the CLI like so:

    qs imode [i]  :: Interactive CLI mode prompts for input, use CTRL-C to exit.

help:

   qs help [h] [command=CMD-NAME] [-min]

output modes:

   [-min]       :: Minimal mode prints in a compacted format containing one object per line.
   [-verbose]   :: Verbose mode prints detailed information about the object with each property on 
                   its own line.
   [-xml]       :: XML output mode returns verbose XML output for integration with scripts and 
                   other systems.

server specification:

   [-server=ipaddress[,username,password]] :: The service specification must be comma delimited 
                                              with no spaces. If no username and password are 
                                              supplied the default Administrator username 'admin' 
                                              and the default password 'password' will be tried.

examples:

   qs help -min
   qs pool-list
   qs volume-list -xml
   qs volume-create name=vol1 size=100G pool=pool0
   qs volume-create vol1 100G pool0 -xml

commands:

   help [h] 
     :: Help page for all commands. Try 'help --min' for a compacted list of commands, or just 
        'help' by itself for a verbose listing of all commands with their input parameters. 
        Optionally you can get help on a specific category or command (ex: help --category=volume).

[--command]  :: A specific CLI command to get detailed help with. [--category]  :: Category of commands to get help with (acl, alert, host, host-group,

                           license, role, session, schedule, pool, quota, system, volume, 
                           volume-group, task, user, user-group).
   alert-list [a-list] 
     :: Returns a list of all the alerts.
   alert-get [a-get] 
     :: Gets information about a specific alert.

<--id>  :: Unique identifer (GUID) for the object.

   alert-raise [a-raise] 
     :: Allows one to raise a user generated alert for testing the SMTP server configuration 
        settings.

<--message>  :: Message string to be echoed back from the server. [--alert-severity] :: Severity of the user generated alert to be raise. [always, critical,

                           error, *info, warning]
   alert-clear [a-clear] 
     :: Deletes the alert with the specified ID.

<--id>  :: Unique identifer (GUID) for the object.

   alert-clear-all [a-clear-all] 
     :: Clears all the alerts.
   alert-config-get [ac-get] 
     :: Alert configuration settings indicate where alert notifications should be sent.
   alert-config-set [ac-set] 
     :: Sets the alert configuration settings such as the administrator email address.

[--sender-email] :: Sender email address to be used for alert emails sent from the storage

                           system.

[--smtp-server]  :: IP Address of the SMTP service where emails should be routed through. [--smtp-user]  :: SMTP user name to use for secure SMTP access to your SMTP server for

                           sending alert emails.

[--smtp-password] :: SMTP password to use for secure SMTP access to your SMTP server. [--smtp-auth]  :: SMTP security mode. [--support-email] :: Email address for local customer support. [--freespace-warning] :: The percentage of free-space left in a pool at which a warning is sent

                           to indicate pool growth plans should be made.

[--freespace-alert] :: The percentage (default=10) of free-space left in a pool at which alerts

                           are generated.

[--freespace-critical] :: The percentage (default=5) of free-space left in a pool at which all

                           provisioning operations are blocked.
   event-list [ev-list] 
     :: Returns a list of all the internal events in the event queue (used for service monitoring).

[--index]  :: Starting event index of where to begin listing events from. [--max]  :: Maxiumum number of events to enumerate. [--time-stamp]  :: Time-stamp of the service.

   task-list [t-list] 
     :: Returns a list of all the tasks including active, completed, and failed tasks.
   task-get [t-get] 
     :: Returns information about the specified task.

<--task>  :: ID of a task.

   task-cancel [t-cancel] 
     :: Cancels the specified task that is in the queue or is running.

<--task>  :: ID of a task.

   task-clear-all [t-clear-all] 
     :: Clears all the completed and/or failed tasks.
   license-get [lic-get] 
     :: Shows the current license key info, and any activation request code.

<--key>  :: Unique license key identifier, use key-enum to get a list of these.

   license-list [lic-list] 
     :: Returns a list of all the registered license keys.
   license-add [lic-add] 
     :: Adds a license key using a license key block.

<--key-file>  :: Key file you recieved which contains a key block section.

   license-remove [lic-remove] 
     :: Removes the specified license key.

<--key>  :: Unique license key identifier, use key-enum to get a list of these.

   license-activate [lic-act] 
     :: Activates the system using a activation key received from customer support.

<--activation-key> :: Activation key you'll receive from customer support after you send the

                           activation request code.
   license-activate-online [lic-aon] 
     :: Requests automatic activation via the online activation service.

<--key>  :: Unique license key identifier, use key-enum to get a list of these.

   user-add [u-add] 
     :: Adds a new user.

<--name>  :: User names may include any alpha-numeric characters '_' and '-', no

                           spaces are allowed.

<--password>  :: A password for the user to use when accessing the QuantaStor management

                           interface.

[--first-name]  :: User's first name; enclose in double-quotes if it contains spaces. [--last-name]  :: User's last name; enclose in double-quotes if it contains spaces. [--email]  :: An email address of the form 'user@example.com' without the quotes. [--role]  :: Name of a security role or its unique ID (GUID). [--desc]  :: A description for the object. [--default-chap-user] :: Default CHAP username for storage volumes owned by a user account which

                           have the CHAP policy set to 'use user default CHAP settings'

[--default-chap-pass] :: Default CHAP password for storage volumes owned by a user account which

                           have the CHAP policy set to 'use user default CHAP settings'

[--alerts]  :: Alert types to subscribe to. Alerts at the subscribed level are sent to

                           the user's email address automatically when a SMTP server is configured. 
                           [critical, error, info, *none, warning]
   user-modify [u-modify] 
     :: Modifies the specified user name, role, and/or description.

<--user>  :: Name or ID (GUID) of a existing user. [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--role]  :: Name of a security role or its unique ID (GUID). [--desc]  :: A description for the object. [--default-chap-user] :: Default CHAP username for storage volumes owned by a user account which

                           have the CHAP policy set to 'use user default CHAP settings'

[--default-chap-pass] :: Default CHAP password for storage volumes owned by a user account which

                           have the CHAP policy set to 'use user default CHAP settings'
   user-password-set [passwd] 
     :: Changes the password for the specified user

<--user>  :: Name or ID (GUID) of a existing user. <--new-password> :: New password for the user. <--old-password> :: Old password for the user.

   user-remove [u-remove] 
     :: Removes the specified user identified by name or ID.

<--user>  :: Name or ID (GUID) of a existing user.

   user-list [u-list] 
     :: Returns a list of all the users.
   user-get [u-get] 
     :: Gets information about the specified user.

<--user>  :: Name or ID (GUID) of a existing user.

   user-group-create [ug-create] 
     :: Creates a new storage user group comprised of the specified storage users

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--user-list>  :: A list of one or more users. [--desc]  :: A description for the object. [--flags]  :: Optional flags for the operation. [async]

   user-group-modify [ug-modify] 
     :: Modifies the name and/or description of a storage user group.

<--user-group>  :: An arbirary group of one or more users. [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object.

   user-group-delete [ug-delete] 
     :: Deletes a storage user group, the users are not deleted unless the delete-users flag is set.

<--user-group>  :: An arbirary group of one or more users. [--flags]  :: Optional flags for the operation. [async, force]

   user-group-list [ug-list] 
     :: Returns a list of all the storage user groups.
   user-group-get [ug-get] 
     :: Returns information about a specific storage user group.

<--user-group>  :: An arbirary group of one or more users.

   user-group-user-add [ugu-add] 
     :: Adds one or more users to the specified user group.

<--user-group>  :: An arbirary group of one or more users. <--user-list>  :: A list of one or more users.

   user-group-user-remove [ugu-remove] 
     :: Removes one or more users from the specified user group

<--user-group>  :: An arbirary group of one or more users. <--user-list>  :: A list of one or more users.

   role-add [r-add] 
     :: Adds a new role to the role based access control (RBAC) system.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object. [--permissions]  :: List of permissions and/or permission groups to add to the specified

                           role.
   role-modify [r-modify] 
     :: Modifies the name and/or description of a role

<--role>  :: Name of a security role or its unique ID (GUID). [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object.

   role-remove [r-remove] 
     :: Removes the specified role identified by name or ID

<--role>  :: Name of a security role or its unique ID (GUID).

   role-list [r-list] 
     :: Returns a list of all the defined roles the RBAC system.
   role-get [r-get] 
     :: Gets information about the specified role.

<--role>  :: Name of a security role or its unique ID (GUID).

   role-permission-add [rp-add] 
     :: Adds additional permissions and/or permission groups to the specified role.

<--role>  :: Name of a security role or its unique ID (GUID). <--permissions>  :: List of permissions and/or permission groups to add to the specified

                           role.
   role-permission-remove [rp-remove] 
     :: Removes one or more permissions and/or permission groups from the specified role.

<--role>  :: Name of a security role or its unique ID (GUID). <--permissions>  :: List of permissions and/or permission groups to add to the specified

                           role.
   session-list [sn-list] 
     :: Returns a list of all the active iSCSI sessions.

[--volume]  :: Name of the storage volume or its unique ID (GUID). [--host]  :: Name of the host or its unique ID (GUID).

   session-get [sn-get] 
     :: Returns detailed information on a specific iSCSI session.

<--session>  :: iSCSI session identifier for an active iSCSI session.

   session-close [sn-close] 
     :: Forcably closes the specified iSCSI session; generally not recommended, use acl-remove 
        instead.

<--session>  :: iSCSI session identifier for an active iSCSI session.

   acl-add [acl-add] 
     :: Enables access to the specific volume from the specified host.

<--volume>  :: Name of the storage volume or its unique ID (GUID). <--host-list>  :: A list of one or more hosts by name or ID.

   acl-remove [acl-remove] 
     :: Disables access to the specific volume from the specified host.

<--volume>  :: Name of the storage volume or its unique ID (GUID). <--host-list>  :: A list of one or more hosts by name or ID.

   acl-list [acl-list] 
     :: Returns a list of all the volume to host assignments, optionally filtered by host or 
        storage volume.

[--volume]  :: Name of the storage volume or its unique ID (GUID). [--host]  :: Name of the host or its unique ID (GUID).

   widget-create [wid-create] 
     :: Create a new widget object

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--flags]  :: Optional flags for the operation. [async, force, *none]

   host-add [h-add] 
     :: Adds the specified host.

<--hostname>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--iqn]  :: IQN (iSCSI Qualified Name) of the host's iSCSI initiator [--ip-address]  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--desc]  :: A description for the object. [--username]  :: Administrator user name for the host, typically 'Administrator' for

                           Windows hosts.

[--password]  :: Administrator password for the host; enables auto-configuration of

                           host's iSCSI initiator.

[--host-type]  :: Operating system type of the host. [aix, hpux, linux, other, solaris,

                           vmware, *windows, xenserver]

[--flags]  :: Optional flags for the operation. [async]

   host-modify [h-modify] 
     :: Modifies a host.

<--host>  :: Name of the host or its unique ID (GUID). [--desc]  :: A description for the object. [--ip-address]  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--username]  :: Administrator user name for the host, typically 'Administrator' for

                           Windows hosts.

[--password]  :: Administrator password for the host; enables auto-configuration of

                           host's iSCSI initiator.

[--host-type]  :: Operating system type of the host. [aix, hpux, linux, other, solaris,

                           vmware, *windows, xenserver]

[--flags]  :: Optional flags for the operation. [async]

   host-remove [h-remove] 
     :: Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.

<--host>  :: Name of the host or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   host-list [h-list] 
     :: Returns a list of all the hosts.
   host-get [h-get] 
     :: Gets information about a specific host.

<--host>  :: Name of the host or its unique ID (GUID).

   host-initiator-get [hi-get] 
     :: Gets information about a specific host identified by its initiator IQN.

<--iqn>  :: IQN (iSCSI Qualified Name) of the host's iSCSI initiator

   host-initiator-add [hi-add] 
     :: Adds an additional iSCSI host initiator IQN to the specified host.

<--host>  :: Name of the host or its unique ID (GUID). <--iqn>  :: IQN (iSCSI Qualified Name) of the host's iSCSI initiator

   host-initiator-remove [hi-remove] 
     :: Removes a iSCSI host initiator (IQN) from the specified host.

<--host>  :: Name of the host or its unique ID (GUID). <--iqn>  :: IQN (iSCSI Qualified Name) of the host's iSCSI initiator

   host-group-create [hg-create] 
     :: Creates a new host group with the specified name.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--host-list>  :: A list of one or more hosts by name or ID. [--desc]  :: A description for the object. [--flags]  :: Optional flags for the operation. [async]

   host-group-modify [hg-modify] 
     :: Modifies the properties of a host group such as its name and/or description.

<--host-group>  :: An arbitrary collection of hosts used to simplify volume ACL management

                           for clusters and other groups of hosts.

[--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object.

   host-group-delete [hg-delete] 
     :: Removes the specified host group.

<--host-group>  :: An arbitrary collection of hosts used to simplify volume ACL management

                           for clusters and other groups of hosts.

[--flags]  :: Optional flags for the operation. [async, force]

   host-group-list [hg-list] 
     :: Returns a list of all the host groups.
   host-group-get [hg-get] 
     :: Gets information about a specific host group.

<--host-group>  :: An arbitrary collection of hosts used to simplify volume ACL management

                           for clusters and other groups of hosts.
   host-group-host-add [hg-host-add] 
     :: Adds a host to the specified host group.

<--host-group>  :: An arbitrary collection of hosts used to simplify volume ACL management

                           for clusters and other groups of hosts.

<--host-list>  :: A list of one or more hosts by name or ID.

   host-group-host-remove [hg-host-remove] 
     :: Removes a host from the specified host group.

<--host-group>  :: An arbitrary collection of hosts used to simplify volume ACL management

                           for clusters and other groups of hosts.

<--host-list>  :: A list of one or more hosts by name or ID.

   system-get [s-get] 
     :: Get general information about the storage system.
   system-shutdown [s-shutdown] 
     :: Shutdown the storage system.

[--flags]  :: Optional flags for the operation. [async, force, *none]

   system-restart [s-restart] 
     :: Restarts the entire storage system.

[--flags]  :: Optional flags for the operation. [async, force, *none]

   system-modify [s-modify] 
     :: Modifies the name and/or description of the storage system.

[--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object. [--location]  :: Optional description indicating the location of the storage system. [--domain]  :: The domain name suffix for your network such as example.com [--search]  :: The default domain search suffix for your network such as example.com [--arp-filter-mode] :: ARP filtering should be enabled when you have more than one network card

                           on the same network. [*auto, disabled, enabled]

[--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-get [tp-get] 
     :: Returns information about the specified target port.

<--port>  :: Name or MAC address of the target port. [--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-list [tp-list] 
     :: Returns a list of all the target ports in the system.
   target-port-restart [tp-restart] 
     :: Restarts the specified target port.

<--port>  :: Name or MAC address of the target port. [--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-disable [tp-disable] 
     :: Disables the specified target port.

<--port>  :: Name or MAC address of the target port. [--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-enable [tp-enable] 
     :: Enables the specified target port.

<--port>  :: Name or MAC address of the target port. [--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-rescan [tp-rescan] 
     :: Discovers new target ports and/or any manual modifiations made to the configuration of the 
        target ports.

[--flags]  :: Optional flags for the operation. [async, force, *none]

   target-port-modify [tp-modify] 
     :: Modifies target port settings including IP address, gateway, mtu, etc.

<--port>  :: Name or MAC address of a target port, or 'all' to modify all ports. [--port-type]  :: Port configuration type. (static, dhcp) [--ip-address]  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--netmask]  :: Subnet IP mask (ex: 255.255.255.0) [--gateway]  :: IP address of the network gateway [--mtu]  :: Maximum transmission unit (MTU) for the target port, commonly set to

                           9000 to enable jumbo frames.

[--iscsi-enable] :: Enables or disables iSCSI access to the specified port(s). [--desc]  :: A description for the object. [--flags]  :: Optional flags for the operation. [async, force, *none]

   pool-create [p-create] 
     :: Creates a new storage pool from which storage volumes can be created.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--disk-list>  :: List of physical drives to be grouped together to create the new storage

                           pool.

[--raid-type]  :: RAID type for the storage pool. [*AUTO, RAID0, RAID1, RAID5, RAID6] [--pool-type]  :: The type of storage pool to be created. [*btrfs, ext4, jfs, xfs] [--desc]  :: A description for the object. [--is-default]  :: Indicates that this pool should be utilized as the default storage pool. [--ssd]  :: Enable solid state disk (SSD) storage pool optimizations. [--compress]  :: Enable storage volume compression on the pool, this boosts both read and

                           write performance on most IO loads.

[--nobarriers]  :: Enable storage pool write optimizations. This requires that you have a

                           hardware controller with a battery backup unit.

[--profile]  :: Specifies an optional IO optimization profile for the storage pool.

                           Storage pool profiles control elements like read-ahead, queue depth and 
                           other device configurables.

[--flags]  :: Optional flags for the operation. [async]

   pool-grow [p-grow] 
     :: Grows the specified storage pool by adding an additional disk.  You can only grow storage 
        pools that are using the RAID5 or RAID6 layout.

<--pool>  :: Name of the storage pool or its unique ID (GUID). <--disk-list>  :: List of physical drives to be grouped together to create the new storage

                           pool.

[--raid-type]  :: RAID type for the storage pool. [*AUTO, RAID0, RAID1, RAID5, RAID6] [--flags]  :: Optional flags for the operation. [async]

   pool-add-spare [p-add] 
     :: Adds a dedicated hot-spare to the specified storage pool.

<--pool>  :: Name of the storage pool or its unique ID (GUID). <--disk-list>  :: List of physical drives to be grouped together to create the new storage

                           pool.

[--flags]  :: Optional flags for the operation. [async]

   pool-remove-spare [p-remove] 
     :: Removes the specified hot-spare from the specified pool.

<--pool>  :: Name of the storage pool or its unique ID (GUID). <--disk-list>  :: List of physical drives to be grouped together to create the new storage

                           pool.

[--flags]  :: Optional flags for the operation. [async]

   pool-modify [p-modify] 
     :: Modifies the properties of the storage pool such as it's name and decription.

<--pool>  :: Name of the storage pool or its unique ID (GUID). [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--is-default]  :: Indicates that this pool should be utilized as the default storage pool. [--ssd]  :: Enable solid state disk (SSD) storage pool optimizations. [--compress]  :: Enable storage volume compression on the pool, this boosts both read and

                           write performance on most IO loads.

[--nobarriers]  :: Enable storage pool write optimizations. This requires that you have a

                           hardware controller with a battery backup unit.

[--profile]  :: Specifies an optional IO optimization profile for the storage pool.

                           Storage pool profiles control elements like read-ahead, queue depth and 
                           other device configurables.

[--desc]  :: A description for the object. [--flags]  :: Optional flags for the operation. [async]

   pool-destroy [p-destroy] 
     :: Deletes a storage pool, *WARNING* any data in the pool will be lost.

<--pool>  :: Name of the storage pool or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   pool-start [p-start] 
     :: Starts up a previously stopped storage pool.

<--pool>  :: Name of the storage pool or its unique ID (GUID).

   pool-stop [p-stop] 
     :: Stops all volume activity to the pool and disables it for maintenance.

<--pool>  :: Name of the storage pool or its unique ID (GUID).

   pool-export [p-export] 
     :: Deactivate and removes the storage pool from the storage system database so that it can be 
        exported and used on another system.

<--pool>  :: Name of the storage pool or its unique ID (GUID).

   pool-list [p-list] 
     :: Returns a list of all the storage pools.
   pool-get [p-get] 
     :: Gets information about a specific storage pool.

<--pool>  :: Name of the storage pool or its unique ID (GUID).

   pool-identify [p-id] 
     :: Pulses the disk activity lights for all disks in the pool so they can be identified in the 
        chassis.

<--pool>  :: Name of the storage pool or its unique ID (GUID). [--pattern]  :: Pattern to flash the disk LED lights in, p = short pulse, P = long

                           pluse, d = short delay, D = long delay, ex: pattern=pppD

[--duration]  :: Duration in seconds to repeat the disk identification pattern.

   disk-list [d-list] 
     :: Enumerates all physical disks.
   disk-scan [d-scan] 
     :: Scans for any new physical disks that may have been hot-plugged into the storage system.
   disk-get [d-get] 
     :: Gets information about a specific physical disk.

<--disk>  :: Name of the physical disk or its unique ID/serial number.

   disk-identify [d-id] 
     :: Pulses the disk activity light so that the specified disk can be identified in the cassis.

<--disk>  :: Name of the physical disk or its unique ID/serial number. [--pattern]  :: Pattern to flash the disk LED lights in, p = short pulse, P = long

                           pluse, d = short delay, D = long delay, ex: pattern=pppD

[--duration]  :: Duration in seconds to repeat the disk identification pattern.

   volume-create [v-create] 
     :: Creates a new storage volume in the specified storage pool.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--size>  :: Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T <--pool>  :: Name of the storage pool or its unique ID (GUID). [--desc]  :: A description for the object. [--thin]  :: Thin provision (sparse allocate) the storage volume. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--chap-policy]  :: CHAP setting can be 'target' which is unique to a storage volume, 'user'

                           or 'resource-group' which inherits the chap user/pass from your user 
                           account or storage cloud respectively. [*disabled, 
                           resource-group-defaults, target, user-defaults]

[--chap-user]  :: An optional iSCSI CHAP username. [--chap-pass]  :: An optional iSCSI CHAP password. [--count]  :: The number of volumes to create, default is 1. [--flags]  :: Optional flags for the operation. [async, force]

   volume-modify [v-modify] 
     :: Modifies a the name, description or other properties of the storage volume.

<--volume>  :: volume [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--flags]  :: Optional flags for the operation. [async] [--chap-policy]  :: CHAP setting can be 'target' which is unique to a storage volume, 'user'

                           or 'resource-group' which inherits the chap user/pass from your user 
                           account or storage cloud respectively. [*disabled, 
                           resource-group-defaults, target, user-defaults]

[--chap-user]  :: An optional iSCSI CHAP username. [--chap-pass]  :: An optional iSCSI CHAP password. [--clear-snap-flag] :: Promotes a snapshot volume to standard (non-snapshot) volume.

   volume-delete [v-delete] 
     :: Deletes a storage volume, *WARNING* any data in the volume will be lost.

<--volume>  :: Name of the storage volume or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   volume-resize [v-resize] 
     :: Resizes a storage volume to make it larger, volumes cannot be reduced in size.

<--volume>  :: Name of the storage volume or its unique ID (GUID). <--new-size>  :: New larger size for the volume specified in MiB, GiB, or TiB. examples:

                           4G, 100M, 1.4T

[--flags]  :: Optional flags for the operation. [async, force]

   volume-restore [v-restore] 
     :: Restores a storage volume to a previous point in time using a snapshot.

<--volume>  :: Name of the storage volume or its unique ID (GUID). <--snapshot>  :: Name or ID of a snapshot volume to use as the restore point. [--flags]  :: Optional flags for the operation. [async, force]

   volume-list [v-list] 
     :: Returns a list of all the storage volumes.
   volume-get [v-get] 
     :: Returns information about a specific storage volume.

<--volume>  :: Name of the storage volume or its unique ID (GUID).

   volume-snapshot [v-snap] 
     :: Creates a space efficient copy of the source volume.

<--volume>  :: Name of the storage volume or its unique ID (GUID). [--name]  :: Name for the snapshot, if not provided the source volume name will be

                           used as a prefix.

[--desc]  :: A description for the object. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--count]  :: The number of snapshots of the specified volume to create, default is 1. [--flags]  :: Optional flags for the operation. [async, force]

   volume-clone [v-clone] 
     :: Creates a complete block copy of the source volume.

<--volume>  :: Name of the storage volume or its unique ID (GUID). [--name]  :: Name for the clone, if not provided the source volume name will be used

                           as a prefix.

[--desc]  :: A description for the object. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--flags]  :: Optional flags for the operation. [async, force]

   volume-utilization-list [vu-list] 
     :: Returns volume utilization information for a specific storage volume or all storage volumes 
        if no volume is specified.

[--volume]  :: Name of the storage volume or its unique ID (GUID).

   volume-utilization-get [vu-get] 
     :: Returns a specific volume utilization metrics for a single volume and specific date.

<--id>  :: Unique identifer (GUID) for the object.

   volume-group-create [vg-create] 
     :: Creates a new storage volume group comprised of the specified storage volumes

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--volume-list>  :: A list of one or more storage volumes. [--desc]  :: A description for the object. [--flags]  :: Optional flags for the operation. [async]

   volume-group-modify [vg-modify] 
     :: Modifies the name and/or description of a storage volume group.

<--volume-group> :: An arbirary group of one or more storage volumes. [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object.

   volume-group-delete [vg-delete] 
     :: Deletes a storage volume group, the volumes are not deleted unless the delete-volumes flag 
        is set.

<--volume-group> :: An arbirary group of one or more storage volumes. [--destroy-volumes] :: If 'true' all the volumes in the group will be deleted with the volume

                           group, default is 'false'.

[--flags]  :: Optional flags for the operation. [async, force]

   volume-group-snapshot [vg-snap] 
     :: Creates a space efficient copy of all volumes in the group.

<--volume-group> :: An arbirary group of one or more storage volumes. [--name-suffix]  :: Name for the snapshot/clone; if unspecified the snapshot/clone will use

                           the original name with '_snapNN'/'_cloneNN' appended.

[--desc]  :: A description for the object. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--count]  :: The number of snapshots of the specified volume to create, default is 1. [--flags]  :: Optional flags for the operation. [async, force]

   volume-group-clone [vg-clone] 
     :: Creates a complete block by block copy of all volumes in the group.

<--volume-group> :: An arbirary group of one or more storage volumes. [--pool]  :: Name of the storage pool or its unique ID (GUID). [--name-suffix]  :: Name for the snapshot/clone; if unspecified the snapshot/clone will use

                           the original name with '_snapNN'/'_cloneNN' appended.

[--desc]  :: A description for the object. [--access-mode]  :: Access mode for the volume. [none, readonly, *readwrite] [--flags]  :: Optional flags for the operation. [async, force]

   volume-group-list [vg-list] 
     :: Returns a list of all the storage volume groups.
   volume-group-get [vg-get] 
     :: Returns information about a specific storage volume group.

<--volume-group> :: An arbirary group of one or more storage volumes.

   volume-group-volume-add [vgv-add] 
     :: Adds one or more volumes to the specified volume group.

<--volume-group> :: An arbirary group of one or more storage volumes. <--volume-list>  :: A list of one or more storage volumes.

   volume-group-volume-remove [vgv-remove] 
     :: Removes one or more volumes from the specified volume group

<--volume-group> :: An arbirary group of one or more storage volumes. <--volume-list>  :: A list of one or more storage volumes.

   snap-schedule-create [sch-create] 
     :: Creates a new snapshot schedule comprised of the specified storage volumes

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--volume-list]  :: A list of one or more storage volumes. [--share-list]  :: A list of one or more network shares. [--start-date]  :: Start date at which the system will begin creating snapshots for a given

                           schedule.

[--enabled]  :: While the schedule is enabled snapshots will be taken at the designated

                           times.

[--desc]  :: A description for the object. [--quota]  :: Name or ID of a storage quota. [--max-snaps]  :: Maximum number of snapshots to retain for this schedule, after which the

                           oldest snapshot is removed before a new one is created.

[--days]  :: The days of the week on which this schedule should create snapshots.

                           [fri, mon, sat, *sun, thu, tue, wed]

[--hours]  :: For the specified days of the week, snapshots will be created at the

                           specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, 
                           *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]

[--flags]  :: Optional flags for the operation. [async]

   snap-schedule-modify [sch-modify] 
     :: Modifies the name, description or other properties of a snapshot schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--start-date]  :: Start date at which the system will begin creating snapshots for a given

                           schedule.

[--enabled]  :: While the schedule is enabled snapshots will be taken at the designated

                           times.

[--desc]  :: A description for the object. [--quota]  :: Name or ID of a storage quota. [--max-snaps]  :: Maximum number of snapshots to retain for this schedule, after which the

                           oldest snapshot is removed before a new one is created.

[--days]  :: The days of the week on which this schedule should create snapshots.

                           [fri, mon, sat, *sun, thu, tue, wed]

[--hours]  :: For the specified days of the week, snapshots will be created at the

                           specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, 
                           *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]

[--flags]  :: Optional flags for the operation. [async]

   snap-schedule-delete [sch-delete] 
     :: Deletes a snapshot schedule, snapshots associated with the schedule are not removed.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   snap-schedule-enable [sch-enable] 
     :: Enables the specified snapshot schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   snap-schedule-disable [sch-disable] 
     :: Disables the specified snapshot schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--flags]  :: Optional flags for the operation. [async, force]

   snap-schedule-list [sch-list] 
     :: Returns a list of all the snapshot schedules.
   snap-schedule-get [sch-get] 
     :: Returns information about a specific snapshot schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID).

   snap-schedule-volume-add [sch-v-add] 
     :: Adds one or more volumes to the specified schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--volume-list]  :: A list of one or more storage volumes. [--share-list]  :: A list of one or more network shares.

   snap-schedule-volume-remove [sch-v-remove] 
     :: Removes one or more volumes from the specified schedule.

<--schedule>  :: Name of a snapshot schedule or its unique ID (GUID). [--volume-list]  :: A list of one or more storage volumes. [--share-list]  :: A list of one or more network shares.

   link-get [sl-get] 
     :: Get information about the storage system link.

<--link>  :: Storage system link ID or name.

   link-list [sl-list] 
     :: List the existing storage system remote replication links.
   link-delete [sl-delete] 
     :: Delete an existing storage system link.

<--link>  :: Storage system link ID or name.

   link-create [sl-create] 
     :: Create a new storage system link so that storage volumes may be replicated between storage 
        systems.

<--remote-ip>  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--remote-admin] :: Remote admin user account to establish remote storage system link with. [--remote-passwd] :: Remote admin user password. [--local-ip]  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--bw-limit]  :: Limits the replication bandwidth between two storage systems to a set

                           level specified in units of kilobytes per second (KB/sec). Specify 0 to 
                           indicate no limit.

[--link-type]  :: Type of storage system link to establish. [--desc]  :: A description for the object.

   link-modify [sl-modify] 
     :: Modify the properties of the storage system link.

<--link>  :: Storage system link ID or name. <--remote-ip>  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--local-ip]  :: IP Address of the host being added; if unspecified the service will look

                           it up.

[--desc]  :: A description for the object. [--bw-limit]  :: Limits the replication bandwidth between two storage systems to a set

                           level specified in units of kilobytes per second (KB/sec). Specify 0 to 
                           indicate no limit.

[--link-type]  :: Type of storage system link to establish.

   link-set-credentials [sl-setcred] 
     :: Change the credentials for an existing storage system link.

<--link>  :: Storage system link ID or name. [--remote-admin] :: Remote admin user account to establish remote storage system link with. [--remote-passwd] :: Remote admin user password.

   hw-controller-group-list [hwcg-list] 
     :: Returns a list of all the hardware controller groups.
   hw-controller-group-get [hwcg-get] 
     :: Returns information about all the support hardware RAID controller group types.

<--controller-group> :: Name or ID of a hardware RAID controller group.

   hw-controller-list [hwc-list] 
     :: Returns a list of all the hardware controllers.

[--controller-group] :: Name or ID of a hardware RAID controller group.

   hw-controller-get [hwc-get] 
     :: Returns information about a specific hardware RAID controller.

<--controller>  :: Name or ID of a hardware RAID controller.

   hw-controller-rescan [hwc-rescan] 
     :: Rescans the hardware controller to look for new disks and RAID units.

<--controller>  :: Name or ID of a hardware RAID controller.

   hw-enclosure-list [hwe-list] 
     :: Returns a list of all the enclosures managed by the specified hardware RAID controller.

[--controller]  :: Name or ID of a hardware RAID controller.

   hw-enclosure-get [hwe-get] 
     :: Returns information about a specific enclosure managed by the specified hardware RAID 
        controller.

<--enclosure>  :: Name of a hardware RAID enclosure or it unique ID.

   hw-unit-list [hwu-list] 
     :: Returns a list of all the RAID units managed by the specified hardware controller.

[--controller]  :: Name or ID of a hardware RAID controller.

   hw-unit-get [hwu-get] 
     :: Returns information about a specific RAID unit managed by the specified hardware RAID 
        controller.

<--unit>  :: Name of a hardware RAID unit or it unique ID.

   hw-unit-identify [hwu-identify] 
     :: Flashes the LED indicator light on all the disks in the RAID unit so that it can be 
        identified in the enclosure.

<--unit>  :: Name of a hardware RAID unit or it unique ID. [--duration]  :: Duration in seconds to repeat the disk identification pattern.

   hw-unit-create [hwu-create] 
     :: Creates a new hardware RAID unit using the specified controller.

<--controller>  :: Name or ID of a hardware RAID controller. <--raid-type>  :: RAID type for the storage pool. [*AUTO, RAID0, RAID1, RAID5, RAID6] <--disk-list>  :: Specifies one or more physical disks connected to a hardware RAID

                           controller. Use 'all' to indicate all unused disks.

[--flags]  :: Optional flags for the operation. [async, force, *none]

   hw-unit-delete [hwu-delete] 
     :: Deletes the specified RAID unit.  Note that you must first delete the Storage Pool before 
        you delete the RAID unit.

<--unit>  :: Name of a hardware RAID unit or it unique ID. [--duration]  :: Duration in seconds to repeat the disk identification pattern.

   hw-disk-identify [hwd-identify] 
     :: Flashes the LED indicator light on the specified disk so that it can be identified in the 
        enclosure chassis.

<--unit>  :: Name of a hardware RAID unit or it unique ID. [--duration]  :: Duration in seconds to repeat the disk identification pattern.

   hw-disk-delete [hwd-delete] 
     :: Marks the specified disk so that it can be removed from the enclosure.  Disks marked as 
        hot-spares will return to normal status after being deleted.

<--disk>  :: Specifies a physical disk connected to a hardware RAID controller. [--duration]  :: Duration in seconds to repeat the disk identification pattern.

   hw-disk-list [hwd-list] 
     :: Returns a list of all the disks managed by the specified hardware controller.

[--controller]  :: Name or ID of a hardware RAID controller.

   hw-disk-get [hwd-get] 
     :: Returns information about a specific disk managed by a hardware RAID controller.

<--disk>  :: Specifies a physical disk connected to a hardware RAID controller.

   hw-disk-mark-spare [hwd-mark-spare] 
     :: Marks the specified disk as a universal hot spare within the group of RAID units managed by 
        the controller in which the disk is attached.

<--disk>  :: Specifies a physical disk connected to a hardware RAID controller.

   hw-alarm-list [hwa-list] 
     :: Returns a list of all the current hardware alarms/alert messages generated from the 
        controller.

[--controller]  :: Name or ID of a hardware RAID controller.

   hw-alarm-get [hwa-get] 
     :: Returns information about a specific hardware alarm.

<--id>  :: Unique identifer (GUID) for the object.

   hw-alarm-clear-all [hwa-clear-all] 
     :: Clears all the hardware alarms that have been recorded for the specified hardware RAID 
        controller.

<--controller>  :: Name or ID of a hardware RAID controller.

   share-create [shr-create] 
     :: Creates a new NFSv3 network share.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--pool>  :: Name of the storage pool or its unique ID (GUID). [--desc]  :: A description for the object. [--public]  :: Indicates that the specified network share should be made public and

                           open for read/write access to all systems on the network.

[--active]  :: Indicates that the network share should be activated. [--flags]  :: Optional flags for the operation. [async, force]

   share-modify [shr-modify] 
     :: Modifies the properties of the specified network share.

<--share>  :: share [--name]  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

[--desc]  :: A description for the object. [--public]  :: Indicates that the specified network share should be made public and

                           open for read/write access to all systems on the network.

[--active]  :: Indicates that the network share should be activated.

   share-delete [shr-delete] 
     :: Deletes the specified network share

<--share>  :: Name or ID of a network share. [--flags]  :: Optional flags for the operation. [async, force]

   share-list [shr-list] 
     :: Returns a list of all the network shares in the system.
   share-get [shr-get] 
     :: Returns information about the specified network share.

<--share>  :: Name or ID of a network share.

   share-client-add [shr-cadd] 
     :: Adds a client for the specified network share.

<--share>  :: share <--filter>  :: A filter string for the client [--async]  :: Use asynchronous communication between NFS server and client [--secure]  :: Requires the requests to originate from an Internet port less than

                           IPPORT_RESERVED

[--subtree]  :: Enables subtree checking [--rdonly]  :: Allow only read requests for the NFS volume [--flags]  :: Optional flags for the operation. [async, force]

   share-client-remove [shr-cremove] 
     :: Removes a client for the specified network share.

<--share>  :: share <--filter>  :: A filter string for the client [--flags]  :: Optional flags for the operation. [async, force]

   share-client-modify [shr-cmodify] 
     :: Modifies a client for the specified network share.

<--share>  :: share <--filter>  :: A filter string for the client [--rdonly]  :: Allow only read requests for the NFS volume [--secure]  :: Requires the requests to originate from an Internet port less than

                           IPPORT_RESERVED

[--async]  :: Use asynchronous communication between NFS server and client [--subtree]  :: Enables subtree checking [--flags]  :: Optional flags for the operation. [async, force]

   share-client-enum [shr-cenum] 
     :: Returns a list of clients for the specified network share.

<--share>  :: share [--flags]  :: Optional flags for the operation. [async, force]

   share-client-get [shr-cget] 
     :: Returns information about the specific network share client.

<--share>  :: share <--filter>  :: A filter string for the client [--flags]  :: Optional flags for the operation. [async, force]

   cloud-backup-provider-get [cbp-get] 
     :: Returns detailed information about the specified cloud provider.

<--provider>  :: A cloud provider is a storage provider like Amazon S3 which QuantaStor

                           utilizes for backup in the cloud.
   cloud-backup-provider-list [cbp-list] 
     :: Returns the list of supported cloud providers.
   cloud-backup-credentials-add [cbcred-add] 
     :: Adds cloud provider credentials to enable cloud backup to cloud backup containers.

<--access-key>  :: The access key provided by your cloud storage provider for accessing

                           your cloud storage account.

<--secret-key>  :: The secret key provided by your cloud storage provider for accessing

                           your cloud storage account.
   cloud-backup-credentials-remove [cbcred-remove] 
     :: Removes the specified cloud provider credentials

<--provider-creds> :: Credentials for accessing your cloud storage provider account. With

                           Amazon S3 this is your 'Access Key ID' and your 'Secret Access Key'.
   cloud-backup-credentials-get [cbcred-get] 
     :: Returns information about the specified cloud provider credential.

<--provider-creds> :: Credentials for accessing your cloud storage provider account. With

                           Amazon S3 this is your 'Access Key ID' and your 'Secret Access Key'.
   cloud-backup-credentials-list [cbcred-list] 
     :: Returns a list of all the cloud provider credentials in the system. Passwords are masked.
   cloud-backup-container-get [cbc-get] 
     :: Retruns detailed information on a specific cloud backup container.

<--container>  :: A cloud backup container into which storage volumes can be backed up. A

                           cloud backup container is like an unlimited storage pool in the cloud.
   cloud-backup-container-list [cbc-list] 
     :: Returns a list of cloud backup containers in the system.
   cloud-backup-container-create [cbc-create] 
     :: Creates a cloud backup container into which cloud backups of storage volumes can be made.

<--name>  :: Names may include any alpha-numeric characters '_' and '-', spaces are

                           not allowed.

<--desc>  :: A description for the object. <--provider-creds> :: Credentials for accessing your cloud storage provider account. With

                           Amazon S3 this is your 'Access Key ID' and your 'Secret Access Key'.

<--locaiton>  :: Cloud storage provider endpoint location. <--encryption-key> :: A passphrase which is used to encrypt all the data sent to the cloud

                           container.
   cloud-backup-container-delete [cbc-delete] 
     :: Deletes the specified cloud backup container. WARNING, all data in the container will be 
        destroyed.

<--container>  :: A cloud backup container into which storage volumes can be backed up. A

                           cloud backup container is like an unlimited storage pool in the cloud.
   cloud-backup-container-add [cbc-add] 
     :: Recovers a cloud backup container that was previously removed or used with a prior 
        installation.

<--provider-creds> :: Credentials for accessing your cloud storage provider account. With

                           Amazon S3 this is your 'Access Key ID' and your 'Secret Access Key'.

<--locaiton>  :: Cloud storage provider endpoint location. <--encryption-key> :: A passphrase which is used to encrypt all the data sent to the cloud

                           container.

<--storage-url>  :: The Amazon S3 or other storage URL used to identify a cloud backup

                           container.
   cloud-backup-container-remove [cbc-remove] 
     :: Removes the specified cloud backup container from the system but does not delete any backup 
        data in the cloud.

<--container>  :: A cloud backup container into which storage volumes can be backed up. A

                           cloud backup container is like an unlimited storage pool in the cloud.
   cloud-backup-container-enable [cbc-enable] 
     :: Enables a cloud container that was previously disabled or was inaccessible due to network 
        connection issues.

<--container>  :: A cloud backup container into which storage volumes can be backed up. A

                           cloud backup container is like an unlimited storage pool in the cloud.
   cloud-backup-container-disable [cbc-disable] 
     :: Disables access to the specified cloud container without having to remove it.

<--container>  :: A cloud backup container into which storage volumes can be backed up. A

                           cloud backup container is like an unlimited storage pool in the cloud.