Difference between revisions of "+ CLI Guide Overview"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (CLI Command Reference)
m
Line 129: Line 129:
  
 
=Command Reference=
 
=Command Reference=
 +
 
==Alert Management [ALERT]==
 
==Alert Management [ALERT]==
 
Alerts are generated by the system and routed to the administrators via the various call-home mechanisms which include email, SNMP, PagerDuty and custom alert handlers.  Alerts include a severity, a descriptive message, and in most cases an identifier referring to the element of the system or grid that is the subject of the alert.
 
Alerts are generated by the system and routed to the administrators via the various call-home mechanisms which include email, SNMP, PagerDuty and custom alert handlers.  Alerts include a severity, a descriptive message, and in most cases an identifier referring to the element of the system or grid that is the subject of the alert.
Line 250: Line 251:
 
Creates a ingest backup policy which pull data from NFS shares to the QuantaStor appliance.
 
Creates a ingest backup policy which pull data from NFS shares to the QuantaStor appliance.
  
<pre> qs backup-policy-create|bp-create --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] </pre>
+
<pre> qs backup-policy-create|bp-create --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value --scan-threads=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 263: Line 264:
 
| &nbsp; || <tt>remote-export-path</tt> || Remote export path to be mounted to access the data to be backed up.
 
| &nbsp; || <tt>remote-export-path</tt> || Remote export path to be mounted to access the data to be backed up.
 
|-
 
|-
| &nbsp; || <tt>remote-export-type</tt> || Remote mount type (currently NFS only) [*nfs]
+
| &nbsp; || <tt>remote-export-type</tt> || Remote mount type [*nfs, smb]
 
|-
 
|-
 
| &nbsp; || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
 
| &nbsp; || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
 
|-
 
|-
| &nbsp; || <tt>policy-type</tt> || Backup policy type [*inbound]
+
| &nbsp; || <tt>policy-type</tt> || Backup policy type [*inbound, outbound]
 
|-
 
|-
| &nbsp; || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export
+
| &nbsp; || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export (Default:1,6,12,24,32,64)
 
|-
 
|-
 
| &nbsp; || <tt>hours</tt> || 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]
 
| &nbsp; || <tt>hours</tt> || 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]
Line 283: Line 284:
 
| &nbsp; || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
 
| &nbsp; || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || Set to enabled to activate the backup policy.
 
| &nbsp; || <tt>enabled</tt> || Set to enabled to activate the backup policy.
 +
|-
 +
| &nbsp; || <tt>smb-username</tt> || Specifies the SMB username to use to access the specified remote filer SMB share.
 +
|-
 +
| &nbsp; || <tt>smb-password</tt> || Specifies the SMB password to use to access the specified remote filer SMB share.
 
|}
 
|}
  
Line 338: Line 343:
 
Modifies the specified backup policy settings.
 
Modifies the specified backup policy settings.
  
<pre> qs backup-policy-modify|bp-modify --policy=value --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] </pre>
+
<pre> qs backup-policy-modify|bp-modify --policy=value [--name=value ] [--desc=value ] [--remote-hostname=value ] [--remote-export-path=value ] [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 346: Line 351:
 
|-
 
|-
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
 
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS network share.
 
 
|-
 
|-
 
| &nbsp; || <tt>remote-hostname</tt> || Name of the remote host containing NFS shares to be backed up
 
| &nbsp; || <tt>remote-hostname</tt> || Name of the remote host containing NFS shares to be backed up
Line 353: Line 356:
 
| &nbsp; || <tt>remote-export-path</tt> || Remote export path to be mounted to access the data to be backed up.
 
| &nbsp; || <tt>remote-export-path</tt> || Remote export path to be mounted to access the data to be backed up.
 
|-
 
|-
| &nbsp; || <tt>remote-export-type</tt> || Remote mount type (currently NFS only) [*nfs]
+
| &nbsp; || <tt>remote-export-type</tt> || Remote mount type [*nfs, smb]
 
|-
 
|-
 
| &nbsp; || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
 
| &nbsp; || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
 
|-
 
|-
| &nbsp; || <tt>policy-type</tt> || Backup policy type [*inbound]
+
| &nbsp; || <tt>policy-type</tt> || Backup policy type [*inbound, outbound]
 
|-
 
|-
| &nbsp; || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export
+
| &nbsp; || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export (Default:1,6,12,24,32,64)
 
|-
 
|-
 
| &nbsp; || <tt>hours</tt> || 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]
 
| &nbsp; || <tt>hours</tt> || 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]
Line 368: Line 371:
 
|-
 
|-
 
| &nbsp; || <tt>purge-policy</tt> || Indicates how old files should be cleaned up / purged from the backup. [after-backup, *daily, never, weekly]
 
| &nbsp; || <tt>purge-policy</tt> || Indicates how old files should be cleaned up / purged from the backup. [after-backup, *daily, never, weekly]
 +
|-
 +
| &nbsp; || <tt>backup-to-root</tt> || Indicates that the backups should go into the root folder of the Network Share.
 
|-
 
|-
 
| &nbsp; || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
 
| &nbsp; || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || Set to enabled to activate the backup policy.
 
| &nbsp; || <tt>enabled</tt> || Set to enabled to activate the backup policy.
 +
|-
 +
| &nbsp; || <tt>smb-username</tt> || Specifies the SMB username to use to access the specified remote filer SMB share.
 +
|-
 +
| &nbsp; || <tt>smb-password</tt> || Specifies the SMB password to use to access the specified remote filer SMB share.
 
|}
 
|}
  
Line 787: Line 796:
 
|-
 
|-
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 +
|}
 +
 +
 +
===ceph-pool-profile-create===
 +
Create a custom ceph pool profile for object or block storage.
 +
 +
<pre> qs ceph-pool-profile-create|cpp-create --ceph-pool-profile=value --ceph-cluster=value --ceph-data-chunk-count=value --ceph-code-chunk-count=value [--desc=value ] [--ceph-profile-failure-domain=value ] [--ceph-profile-technique=value ] [--ceph-profile-plugin=value ] [--flags=value ] </pre>
 +
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>ceph-pool-profile</tt> || Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
 +
|-
 +
| &nbsp; || <tt>desc</tt> || A description for the object.
 +
|-
 +
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
 +
|-
 +
| &nbsp; || <tt>ceph-data-chunk-count</tt> || Data chunk count for erasure coded ceph pool.
 +
|-
 +
| &nbsp; || <tt>ceph-code-chunk-count</tt> || checksum (code) chunk count for erasure coded ceph pool.
 +
|-
 +
| &nbsp; || <tt>ceph-profile-failure-domain</tt> || Failure domain for the ceph pool {Default: host}.
 +
|-
 +
| &nbsp; || <tt>ceph-profile-technique</tt> || Erasure coding technique for ceph pool. {Default: reed-solomon-van}
 +
|-
 +
| &nbsp; || <tt>ceph-profile-plugin</tt> || ceph plugin used for erasure coded pool {Default: jerasure}
 +
|-
 +
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 +
|}
 +
 +
 +
===ceph-pool-profile-delete===
 +
Deletes the specified ceph pool profile.
 +
 +
<pre> qs ceph-pool-profile-delete|cpp-delete --ceph-pool-profile=value [--flags=value ] </pre>
 +
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>ceph-pool-profile</tt> || Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
 +
|-
 +
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 +
|}
 +
 +
 +
===ceph-pool-profile-get===
 +
Gets information about a specific ceph pool profile.
 +
 +
<pre> qs ceph-pool-profile-get|cpp-get --ceph-pool-profile=value [--flags=value ] </pre>
 +
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>ceph-pool-profile</tt> || Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
 +
|-
 +
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
 +
|}
 +
 +
 +
===ceph-pool-profile-list===
 +
Returns a list of all the ceph pool profile(s) present in the cluster.
 +
 +
<pre> qs ceph-pool-profile-list|cpp-list --ceph-cluster=value [--flags=value ] </pre>
 +
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
 +
|-
 +
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
 
|}
 
|}
  
Line 911: Line 982:
 
| &nbsp; || <tt>volume-list</tt> || A list of one or more storage volumes.
 
| &nbsp; || <tt>volume-list</tt> || A list of one or more storage volumes.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 989: Line 1,060:
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 1,258: Line 1,329:
  
 
===disk-global-spare-marker-cleanup===
 
===disk-global-spare-marker-cleanup===
Cleans up invalid marker records for the dedicated hotspare physical disks in the global hotspare pool.
+
Cleans up invalid marker records for the dedicated hotspare physical disks in the global hot-spare pool.
  
 
<pre> qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] </pre>
 
<pre> qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] </pre>
Line 1,292: Line 1,363:
  
 
===disk-global-spare-marker-list===
 
===disk-global-spare-marker-list===
Enumerates marker records for the dedicated hotspare physical disks in the global hotspare pool.
+
Enumerates marker records for the dedicated hotspare physical disks in the global hot-spare pool.
  
 
<pre> qs disk-global-spare-marker-list|hsm-list [--flags=value ] </pre>
 
<pre> qs disk-global-spare-marker-list|hsm-list [--flags=value ] </pre>
Line 1,477: Line 1,548:
 
<pre> qs gluster-volume-list|gv-list </pre>
 
<pre> qs gluster-volume-list|gv-list </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
===gluster-volume-modify===
 
Modifies the name and/or description of the specified Gluster volume.
 
 
<pre> qs gluster-volume-modify|gv-modify --gluster-volume=value --name=value [--desc=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
|-
 
| &nbsp; || <tt>gluster-volume</tt> || Name or ID of the Gluster volume
 
|-
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
|-
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
|-
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 
|}
 
 
  
 
===gluster-volume-rebalance===
 
===gluster-volume-rebalance===
Line 1,554: Line 1,609:
 
Get general information about the associated storage system management grid.
 
Get general information about the associated storage system management grid.
  
<pre> qs grid-assoc-get|mg-aget --name=value --storage-system=value [--flags=value ] </pre>
+
<pre> qs grid-assoc-get|mg-aget --storage-system=value [--grid=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
|-
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
 
|-
 
|-
 
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
 
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
 +
|-
 +
| &nbsp; || <tt>grid</tt> || Name or ID of the storage system grid.
 
|-
 
|-
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 1,733: Line 1,788:
 
Modifies the settings for the specified high-availability group
 
Modifies the settings for the specified high-availability group
  
<pre> qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-secondary=value ] [--ha-module=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] </pre>
+
<pre> qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-secondary=value ] [--ha-module=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 1,748: Line 1,803:
 
| &nbsp; || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity.  If there's no connectivity a preemptive failover is attempted.
 
| &nbsp; || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity.  If there's no connectivity a preemptive failover is attempted.
 
|-
 
|-
| &nbsp; || <tt>client-connectivity-check-policy</tt> || Client connectivity failover policy. [all-nonresponsive, *disabled, majority-nonresponsive]
+
| &nbsp; || <tt>client-connectivity-check-policy</tt> || Client connectivity failover policy indicates policy on when to failover if the designated IPs are not reponding to ping checks. [all-nonresponsive, *disabled, majority-nonresponsive]
 +
|-
 +
| &nbsp; || <tt>port-linkstate-policy</tt> || Failover policy for Link Down ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
 
|}
 
|}
  
Line 2,351: Line 2,408:
 
</div>
 
</div>
  
==SAS Switch Management [HWSWITCH]==
+
==License Management [LICENSE]==
DEPRECATED
+
Commands for management of QuantaStor license keys including adding, removing and listing keys within a grid of one or more appliances.
 
<div class='mw-collapsible'>
 
<div class='mw-collapsible'>
 
<div class='mw-collapsible-content'>
 
<div class='mw-collapsible-content'>
  
===hw-switch-adapter-get===
+
===license-activate===
Returns information about the specified HW switch management module.
+
Activates the system using a activation key received from customer support.
  
<pre> qs hw-switch-adapter-get|hwsa-get --switch-adapter=value </pre>
+
<pre> qs license-activate|lic-act --activation-key=value </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>switch-adapter</tt> || Storage switch adapter module ID
+
| &nbsp; || <tt>activation-key</tt> || Activation key you'll receive from customer support after you send the activation request code.
 
|}
 
|}
  
  
===hw-switch-adapter-list===
+
===license-activate-online===
Returns a list of all the storage switch management adapters
+
Requests automatic activation via the online activation service.
  
<pre> qs hw-switch-adapter-list|hwsa-list </pre>
+
<pre> qs license-activate-online|lic-aon [--key=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
 +
|}
  
===hw-switch-cred-add===
 
Adds storage switch login credentials for a specific switch management adapter
 
  
<pre> qs hw-switch-cred-add|hwsc-add --username=value --password=value --domain-password=value --ip-address=value [--switch-adapter=value ] [--primary=value ] [--secondary=value ] </pre>
+
===license-add===
 +
Adds a license key using a license key block specified in a key file. In general, you have 7 days to activate your license using online activation of activation via email. If you do not activate after the 7 days the system will continue to run but you will not be able to make configuration changes.
 +
 
 +
<pre> qs license-add|lic-add --key-file=value [--storage-system=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
+
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
 
|-
 
|-
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
+
| &nbsp; || <tt>key-file</tt> || Key file you received which contains a key block section.
|-
+
| &nbsp; || <tt>domain-password</tt> || Password for the committing zoneset changes to a storage switch.
+
|-
+
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
+
|-
+
| &nbsp; || <tt>switch-adapter</tt> || Storage switch adapter module ID
+
|-
+
| &nbsp; || <tt>primary</tt> || Primary storage system responsible for managing and discovering the switch(es)
+
|-
+
| &nbsp; || <tt>secondary</tt> || Secondary storage system responsible for managing and discovering the switch(es)
+
 
|}
 
|}
  
  
===hw-switch-cred-get===
+
===license-get===
Returns information about specific storage switch login credentials
+
Shows the current license key info, and any activation request code.
  
<pre> qs hw-switch-cred-get|hwsc-get --creds=value </pre>
+
<pre> qs license-get|lic-get [--key=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>creds</tt> || Storage switch credentials (user/pass)
+
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
 
|}
 
|}
  
  
===hw-switch-cred-list===
+
===license-list===
Returns a list of all the storage switch login credentials
+
Returns a list of all the registered license keys.
  
<pre> qs hw-switch-cred-list|hwsc-list [--switch-adapter=value ] </pre>
+
<pre> qs license-list|lic-list </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
|-
 
| &nbsp; || <tt>switch-adapter</tt> || Storage switch adapter module ID
 
|}
 
  
 +
===license-remove===
 +
Removes the specified license key.
  
===hw-switch-cred-remove===
+
<pre> qs license-remove|lic-remove --key=value </pre>
Removes storage switch login credentials
+
 
+
<pre> qs hw-switch-cred-remove|hwsc-remove --creds=value </pre>
+
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>creds</tt> || Storage switch credentials (user/pass)
+
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
 
|}
 
|}
  
 +
</div>
 +
</div>
  
===hw-switch-failover-group-activate===
+
==Cloud I/O Stats Management [METRICS]==
Activates the pools in a switch failover group on the specified storage system
+
Commands for the configuration and management of Librato Metrics cloud stats collection system.
 +
<div class='mw-collapsible'>
 +
<div class='mw-collapsible-content'>
  
<pre> qs hw-switch-failover-group-activate|hwsfg-activate --failover-group=value --storage-system=value </pre>
+
===metrics-get===
 +
Get the current username, token, and interval settings for Librato Metrics.
 +
 
 +
<pre> qs metrics-get|lm-get --storage-system=value </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
|-
 
| &nbsp; || <tt>failover-group</tt> || Name/ID of a storage switch failover group
 
 
|-
 
|-
 
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
 
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
Line 2,436: Line 2,488:
  
  
===hw-switch-failover-group-create===
+
===metrics-set===
Creates a new switch failover group
+
Set the username, token, and interval for Librato Metrics posting.
  
<pre> qs hw-switch-failover-group-create|hwsfg-create --name=value --pool-list=value --sys-primary=value --zoneset-primary=value --sys-secondary=value --zoneset-secondary=value [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--desc=value ] </pre>
+
<pre> qs metrics-set|lm-set --username=value --token=value [--storage-system=value ] [--interval=value ] [--dashboards=value ] [--alert-anno=value ] [--config-anno=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
+
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
 
|-
 
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
+
| &nbsp; || <tt>username</tt> || The username/email of the Librato Metrics account.
 
|-
 
|-
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
+
| &nbsp; || <tt>token</tt> || The API token associated with the Librato Metrics account.
 
|-
 
|-
| &nbsp; || <tt>zoneset-primary</tt> || Zoneset to be associated with the failover group primary node
+
| &nbsp; || <tt>interval</tt> || The interval in seconds of how often QuantaStor should post data to Librato Metrics.
 
|-
 
|-
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
+
| &nbsp; || <tt>dashboards</tt> || Automatically create the QuantaStor system dashboard in Librato Metrics
 
|-
 
|-
| &nbsp; || <tt>zoneset-secondary</tt> || Zoneset to be associated with the failover group secondary node
+
| &nbsp; || <tt>alert-anno</tt> || Add alert annotations to the Librato Metrics postings.
 
|-
 
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
+
| &nbsp; || <tt>config-anno</tt> || Add config annotations to the Librato Metrics postings.
|-
+
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
+
|-
+
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
+
|-
+
| &nbsp; || <tt>desc</tt> || A description for the object.
+
 
|}
 
|}
  
 +
</div>
 +
</div>
  
===hw-switch-failover-group-delete===
+
==Network Share Namespace Management [NAMESPACE]==
Deletes a failover group
+
Commands for managing Network Shares Namespaces which controls NFS redirects and Microsoft DFS for the SMB protocol.
 +
<div class='mw-collapsible'>
 +
<div class='mw-collapsible-content'>
  
<pre> qs hw-switch-failover-group-delete|hwsfg-delete --failover-group=value </pre>
+
===share-namespace-add-shares===
{| cellspacing='0' cellpadding='5'
+
Adds one or more shares to the specified Network Share Namespace.
|-
+
| &nbsp; || <tt>failover-group</tt> || Name/ID of a storage switch failover group
+
|}
+
  
 
+
<pre> qs share-namespace-add-shares|nspc-add-shares --namespace=value --preferred-ports=value --share-list=value </pre>
===hw-switch-failover-group-get===
+
Returns information about a specific switch failover group
+
 
+
<pre> qs hw-switch-failover-group-get|hwsfg-get --failover-group=value </pre>
+
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>failover-group</tt> || Name/ID of a storage switch failover group
+
| &nbsp; || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|}
+
 
+
 
+
===hw-switch-failover-group-list===
+
Returns a list of all the switch failover groups
+
 
+
<pre> qs hw-switch-failover-group-list|hwsfg-list [--switch=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>switch</tt> || Name or ID of a SAS/FC storage switch
+
| &nbsp; || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
 +
|-
 +
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
|}
 
|}
  
  
===hw-switch-failover-group-modify===
+
===share-namespace-create===
Modifies the properties of a failover group
+
Creates a new Network Share Namespace which provides the ability to combine shares across appliances into a single namepace which integrates with Microsoft DFS.
  
<pre> qs hw-switch-failover-group-modify|hwsfg-modify --failover-group=value [--name=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--pool-list=value ] [--sys-primary=value ] [--zoneset-primary=value ] [--sys-secondary=value ] [--zoneset-secondary=value ] [--desc=value ] </pre>
+
<pre> qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--enable-msdfs=value ] [--enable-nfsredir=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
|-
 
| &nbsp; || <tt>failover-group</tt> || Name/ID of a storage switch failover group
 
 
|-
 
|-
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
|-
 
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
+
| &nbsp; || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
 
|-
 
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
+
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
|-
 
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
+
| &nbsp; || <tt>desc</tt> || A description for the object.
 
|-
 
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
+
| &nbsp; || <tt>enable-msdfs</tt> || Enables Microsoft DFS support for all shares in the namespace.
 
|-
 
|-
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
+
| &nbsp; || <tt>enable-nfsredir</tt> || Enables NFSv4 redirects for all shares in the namespace.
 
|-
 
|-
| &nbsp; || <tt>zoneset-primary</tt> || Zoneset to be associated with the failover group primary node
+
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
+
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
+
|-
+
| &nbsp; || <tt>zoneset-secondary</tt> || Zoneset to be associated with the failover group secondary node
+
|-
+
| &nbsp; || <tt>desc</tt> || A description for the object.
+
 
|}
 
|}
  
  
===hw-switch-get===
+
===share-namespace-delete===
Returns detailed information about a storage switch
+
Deletes the specified Network Share Namespace, associated Network Shares are not deleted.
  
<pre> qs hw-switch-get|hws-get --switch=value </pre>
+
<pre> qs share-namespace-delete|nspc-delete --namespace=value [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>switch</tt> || Name or ID of a SAS/FC storage switch
+
| &nbsp; || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|}
+
 
+
 
+
===hw-switch-list===
+
Returns a list of all the discovered storage switches
+
 
+
<pre> qs hw-switch-list|hws-list [--switch-adapter=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>switch-adapter</tt> || Storage switch adapter module ID
+
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
 
|}
 
|}
  
  
===hw-switch-zoneset-activate===
+
===share-namespace-get===
Activates a specific storage switch zonset
+
Returns detailed information about the specified Network Share Namespace.
  
<pre> qs hw-switch-zoneset-activate|hwsz-activate --zoneset=value [--switch=value ] </pre>
+
<pre> qs share-namespace-get|nspc-get --namespace=value </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>zoneset</tt> || Name or ID of a storage switch zoneset
+
| &nbsp; || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
+
| &nbsp; || <tt>switch</tt> || Name or ID of a SAS/FC storage switch
+
 
|}
 
|}
  
  
===hw-switch-zoneset-get===
+
===share-namespace-list===
Returns information about a specific switch zoneset
+
Returns a list of all the Network Share Namespaces in the grid.
  
<pre> qs hw-switch-zoneset-get|hwsz-get --zoneset=value </pre>
+
<pre> qs share-namespace-list|nspc-list </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
|-
 
| &nbsp; || <tt>zoneset</tt> || Name or ID of a storage switch zoneset
 
|}
 
 
  
===hw-switch-zoneset-list===
+
===share-namespace-modify===
Returns a list of all the discovered zonesets
+
Modifies the selected Network Share Namespace properties including name, description, and features.
  
<pre> qs hw-switch-zoneset-list|hwsz-list [--switch=value ] </pre>
+
<pre> qs share-namespace-modify|nspc-modify --namespace=value [--name=value ] [--desc=value ] [--enable-msdfs=value ] [--enable-nfsredir=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>switch</tt> || Name or ID of a SAS/FC storage switch
+
| &nbsp; || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|}
+
 
+
</div>
+
</div>
+
 
+
==License Management [LICENSE]==
+
Commands for management of QuantaStor license keys including adding, removing and listing keys within a grid of one or more appliances.
+
<div class='mw-collapsible'>
+
<div class='mw-collapsible-content'>
+
 
+
===license-activate===
+
Activates the system using a activation key received from customer support.
+
 
+
<pre> qs license-activate|lic-act --activation-key=value </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>activation-key</tt> || Activation key you'll receive from customer support after you send the activation request code.
+
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
|}
+
 
+
 
+
===license-activate-online===
+
Requests automatic activation via the online activation service.
+
 
+
<pre> qs license-activate-online|lic-aon [--key=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
+
| &nbsp; || <tt>desc</tt> || A description for the object.
|}
+
 
+
 
+
===license-add===
+
Adds a license key using a license key block specified in a key file. In general, you have 7 days to activate your license using online activation of activation via email. If you do not activate after the 7 days the system will continue to run but you will not be able to make configuration changes.
+
 
+
<pre> qs license-add|lic-add --key-file=value [--storage-system=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
+
| &nbsp; || <tt>enable-msdfs</tt> || Enables Microsoft DFS support for all shares in the namespace.
 
|-
 
|-
| &nbsp; || <tt>key-file</tt> || Key file you received which contains a key block section.
+
| &nbsp; || <tt>enable-nfsredir</tt> || Enables NFSv4 redirects for all shares in the namespace.
|}
+
 
+
 
+
===license-get===
+
Shows the current license key info, and any activation request code.
+
 
+
<pre> qs license-get|lic-get [--key=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
+
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
 
|}
 
|}
  
  
===license-list===
+
===share-namespace-remove-shares===
Returns a list of all the registered license keys.
+
Removes one or more shares from the specified Network Share Namespace.
  
<pre> qs license-list|lic-list </pre>
+
<pre> qs share-namespace-remove-shares|nspc-remove-shares --namespace=value --preferred-ports=value --share-list=value </pre>
{| cellspacing='0' cellpadding='5'
+
 
+
===license-remove===
+
Removes the specified license key.
+
 
+
<pre> qs license-remove|lic-remove --key=value </pre>
+
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
+
| &nbsp; || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|}
+
 
+
</div>
+
</div>
+
 
+
==Cloud I/O Stats Management [METRICS]==
+
Commands for the configuration and management of Librato Metrics cloud stats collection system.
+
<div class='mw-collapsible'>
+
<div class='mw-collapsible-content'>
+
 
+
===metrics-get===
+
Get the current username, token, and interval settings for Librato Metrics.
+
 
+
<pre> qs metrics-get|lm-get --storage-system=value </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
+
| &nbsp; || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
|}
+
 
+
 
+
===metrics-set===
+
Set the username, token, and interval for Librato Metrics posting.
+
 
+
<pre> qs metrics-set|lm-set --username=value --token=value [--storage-system=value ] [--interval=value ] [--dashboards=value ] [--alert-anno=value ] [--config-anno=value ] </pre>
+
{| cellspacing='0' cellpadding='5'
+
 
|-
 
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a storage system in a management grid.
+
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
|-
+
| &nbsp; || <tt>username</tt> || The username/email of the Librato Metrics account.
+
|-
+
| &nbsp; || <tt>token</tt> || The API token associated with the Librato Metrics account.
+
|-
+
| &nbsp; || <tt>interval</tt> || The interval in seconds of how often QuantaStor should post data to Librato Metrics.
+
|-
+
| &nbsp; || <tt>dashboards</tt> || Automatically create the QuantaStor system dashboard in Librato Metrics
+
|-
+
| &nbsp; || <tt>alert-anno</tt> || Add alert annotations to the Librato Metrics postings.
+
|-
+
| &nbsp; || <tt>config-anno</tt> || Add config annotations to the Librato Metrics postings.
+
 
|}
 
|}
  
Line 2,688: Line 2,623:
  
 
===pool-add-spare===
 
===pool-add-spare===
Adds a dedicated hotspare to the specified storage pool.
+
Adds a dedicated hot-spare to the specified storage pool.
  
 
<pre> qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] </pre>
 
<pre> qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] </pre>
Line 2,713: Line 2,648:
 
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool. [*AUTO, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID6]
 
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool. [*AUTO, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID6]
 
|-
 
|-
| &nbsp; || <tt>pool-type</tt> || The type of storage pool to be created. [btrfs, ceph, ext4, jfs, *xfs, zfs]
+
| &nbsp; || <tt>pool-type</tt> || The type of storage pool to be created. [btrfs, ceph, ext4, jfs, swap, *xfs, zfs]
 
|-
 
|-
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
| &nbsp; || <tt>desc</tt> || A description for the object.
Line 2,742: Line 2,677:
 
Deletes a storage pool, *WARNING* any data in the pool will be lost.
 
Deletes a storage pool, *WARNING* any data in the pool will be lost.
  
<pre> qs pool-destroy|p-destroy --pool=value [--flags=value ] </pre>
+
<pre> qs pool-destroy|p-destroy --pool=value [--shred-mode=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
 
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
 
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
 +
|-
 +
| &nbsp; || <tt>shred-mode</tt> || Indicates the mode used to shred data on all the disks in the pool as part of the pool destroy process. [dod, nnsa, *none, random, usarmy, zeros]
 
|-
 
|-
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
Line 2,918: Line 2,855:
  
 
===pool-remove-spare===
 
===pool-remove-spare===
Removes the specified hotspare from the specified pool.
+
Removes the specified hot-spare from the specified pool.
  
 
<pre> qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] </pre>
 
<pre> qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] </pre>
Line 2,944: Line 2,881:
  
 
===pool-scrub-start===
 
===pool-scrub-start===
Starts a scrub/verify operation on a ZFS-based storage pool (verifies data integrity and prevents bit-rot).See 'zpoolscrub' command for additional control. For example, 'zpoolscrub --cron' will setup an automatic monthly scrub.
+
Starts a scrub/verify operation on a ZFS-based Storage Pool (verifies data integrity and auto-corrects any bit-rot).See 'zpoolscrub' command for additional control. For example, 'zpoolscrub --cron' will setup an automatic monthly scrub.
  
 
<pre> qs pool-scrub-start|p-scrub-start --pool=value [--flags=value ] </pre>
 
<pre> qs pool-scrub-start|p-scrub-start --pool=value [--flags=value ] </pre>
Line 2,956: Line 2,893:
  
 
===pool-scrub-stop===
 
===pool-scrub-stop===
Stops the an active scrub/verify operation on a ZFS-based storage pool.
+
Stops the an active scrub/verify operation on a ZFS-based Storage Pool.
  
 
<pre> qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] </pre>
 
<pre> qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] </pre>
Line 3,001: Line 2,938:
  
 
===qos-policy-create===
 
===qos-policy-create===
Creates a new Quality-of-Service (QoS) policy template, which can apply performance limits to storage volumes.
+
Creates a new Quality-of-Service (QoS) policy template, which is used to apply throughput performance limits on Storage Volumes.
  
 
<pre> qs qos-policy-create|qos-create --name=value --bw-read=value --bw-write=value [--desc=value ] [--flags=value ] </pre>
 
<pre> qs qos-policy-create|qos-create --name=value --bw-read=value --bw-write=value [--desc=value ] [--flags=value ] </pre>
Line 3,316: Line 3,253:
 
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 3,400: Line 3,337:
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 3,495: Line 3,432:
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
|-
 
|-
| &nbsp; || <tt>resource-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [building, *rack, region, server, site]
+
| &nbsp; || <tt>resource-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
 
|-
 
|-
 
| &nbsp; || <tt>resource-parent</tt> || Parent domain resource name or ID.  For example a rack resource can have a parent resource of type site or building.
 
| &nbsp; || <tt>resource-parent</tt> || Parent domain resource name or ID.  For example a rack resource can have a parent resource of type site or building.
Line 3,543: Line 3,480:
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
| &nbsp; || <tt>desc</tt> || A description for the object.
 
|-
 
|-
| &nbsp; || <tt>resource-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [building, *rack, region, server, site]
+
| &nbsp; || <tt>resource-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
 
|-
 
|-
 
| &nbsp; || <tt>resource-parent</tt> || Parent domain resource name or ID.  For example a rack resource can have a parent resource of type site or building.
 
| &nbsp; || <tt>resource-parent</tt> || Parent domain resource name or ID.  For example a rack resource can have a parent resource of type site or building.
Line 3,868: Line 3,805:
 
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
| &nbsp; || <tt>share-list</tt> || A list of one or more network shares.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 3,948: Line 3,885:
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
| &nbsp; || <tt>name</tt> || Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
 
|-
 
|-
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule.
+
| &nbsp; || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
 
|-
 
|-
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
Line 4,159: Line 4,096:
  
 
===share-create===
 
===share-create===
Creates a new NFS v3 network share.
+
Creates a new network share accessible via NFS v3/v4 and the SMB protocol.
  
 
<pre> qs share-create|shr-create --name=value --pool=value [--desc=value ] [--public=value ] [--active=value ] [--cifs-enable=value ] [--user-access-list=value ] [--cifs-options=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--flags=value ] </pre>
 
<pre> qs share-create|shr-create --name=value --pool=value [--desc=value ] [--public=value ] [--active=value ] [--cifs-enable=value ] [--user-access-list=value ] [--cifs-options=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--flags=value ] </pre>
Line 4,462: Line 4,399:
 
Returns detailed information about the specified site association.
 
Returns detailed information about the specified site association.
  
<pre> qs site-cluster-assoc-get|sca-get [--system=value ] [--site-assoc=value ] </pre>
+
<pre> qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 4,710: Line 4,647:
 
|-
 
|-
 
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
 
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
 +
|}
 +
 +
 +
===sw-controller-autoconfig===
 +
Creates all necessary hosts, storage volume assignments and iSCSI SAN adapters required to connect the specified systems to the specified storage volumes.
 +
 +
<pre> qs sw-controller-autoconfig|swc-autoconfig --sys-list=value --volume-list=value </pre>
 +
{| cellspacing='0' cellpadding='5'
 +
|-
 +
| &nbsp; || <tt>sys-list</tt> || List of one or more storage systems.
 +
|-
 +
| &nbsp; || <tt>volume-list</tt> || List of one or more storage volumes.
 
|}
 
|}
  
Line 4,808: Line 4,757:
  
 
==Object Storage Management [SWIFT]==
 
==Object Storage Management [SWIFT]==
Commands for object storage setup and user management within a QuantaStor managed Ceph cluster.
+
Commands for S3/SWIFT object storage setup and user management within a QuantaStor managed Ceph cluster.
 
<div class='mw-collapsible'>
 
<div class='mw-collapsible'>
 
<div class='mw-collapsible-content'>
 
<div class='mw-collapsible-content'>
Line 4,815: Line 4,764:
 
Creates a new Object Pool Group for the Ceph Cluster to enable S3/SWIFT object storage gateway access.
 
Creates a new Object Pool Group for the Ceph Cluster to enable S3/SWIFT object storage gateway access.
  
<pre> qs ceph-object-pool-group-create|cog-create --ceph-cluster=value --name=value [--desc=value ] [--object-store-zone=value ] [--object-store-region=value ] [--sys-list=value ] [--flags=value ] </pre>
+
<pre> qs ceph-object-pool-group-create|cog-create --ceph-cluster=value --name=value [--desc=value ] [--object-store-zone=value ] [--object-store-region=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--ceph-pool-profile=value ] [--sys-list=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 4,828: Line 4,777:
 
| &nbsp; || <tt>object-store-region</tt> || Ceph object storage region. (Default: 'default')
 
| &nbsp; || <tt>object-store-region</tt> || Ceph object storage region. (Default: 'default')
 
|-
 
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more storage systems
+
| &nbsp; || <tt>pool-type</tt> || Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
 +
|-
 +
| &nbsp; || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
 +
|-
 +
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
 +
|-
 +
| &nbsp; || <tt>ceph-pool-profile</tt> || Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
 +
|-
 +
| &nbsp; || <tt>sys-list</tt> || List of one or more storage systems.
 
|-
 
|-
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
 
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
Line 5,024: Line 4,981:
 
Modifies the name and/or description of the storage system.
 
Modifies the name and/or description of the storage system.
  
<pre> qs system-modify|sys-modify [--storage-system=value ] [--name=value ] [--desc=value ] [--location=value ] [--domain=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--flags=value ] </pre>
+
<pre> qs system-modify|sys-modify --storage-system=value [--name=value ] [--desc=value ] [--location=value ] [--domain=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--flags=value ] </pre>
 
{| cellspacing='0' cellpadding='5'
 
{| cellspacing='0' cellpadding='5'
 
|-
 
|-
Line 5,689: Line 5,646:
 
| &nbsp; || <tt>default-chap-pass</tt> || Default CHAP password for storage volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
 
| &nbsp; || <tt>default-chap-pass</tt> || Default CHAP password for storage volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
 
|-
 
|-
| &nbsp; || <tt>lock-account</tt> || Lock/disable the user account.
+
| &nbsp; || <tt>lock-account</tt> || Set to 'true' to lock the account, 'false' to unlock the user account.
 
|-
 
|-
 
| &nbsp; || <tt>alerts</tt> || 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]
 
| &nbsp; || <tt>alerts</tt> || 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]

Revision as of 14:33, 23 November 2016

The QuantaStor command line interface (CLI) can be used to remotely manage your QuantaStor based systems via a Windows or Linux system, and it is also a powerful tool for scripting the configuration and provisioning of storage volumes, network shares, and other 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 OSNEXUS web site.

Contents

How to use the CLI

QuantaStor CLI is a full featured interface into all of the QuantaStor management features and can communicates with the local core management service as well as remote storage appliances.

Authentication

It is important to note that running the qs CLI locally as root affords no additional access privileges. Each command run via the CLI must include the --server specification which includes which server and what credentials should be used to access the appliance with.

Authentication via --server Argument

All CLI commands accept the server specification argument which is of this form:

[--server=ipaddress[,username,password]]

If you do not specify a username or password it will try to use the defaults which are 'admin' and 'password'.

Authentication via QS_SERVER Environment Variable

Rather than having to specify the --server argument over and over again you can set an environment variable once then it will use this as the default appliance IP address and credentials. The form of the variable is like so:

export QS_SERVER=ipaddress[,username,password]]

Examples:

export QS_SERVER=localhost,admin,password
export QS_SERVER=10.0.5.10,admin,mypass123
export QS_SERVER=myhostname.domain.net,mike,mypass123

Authentication via .qs.cnf Configuration File

Finally, rather than using an environment variable you can also create a file in your home directory called .qs.cnf with your credentials in it. Here's an example of how to create the file:

echo "192.168.0.10,admin,password" > ~/.qs.cnf
chmod 600 ~/.qs.cnf

Usage

The general usage format for all CLI commands is as follows:

    
qs command <-mandatory-arg=val> [-optional-arg=val] [-flags=force,async,...] [-server=ipaddress[,username,password]] [-xml] [-min] 

As you read through the CLI documentation note that all arguments that are specified in angle backets <> are mandatory required arguments. Arguments in square brackets [] are optional and you'll generally see the default argument specified in the documentation. Note that the qs CLI is installed on your QuantaStor system so you can run it from there, or from a Windows system using our Remote Management CLI Installer found on the downloads page. All commands can be run against a remote QuantaStor storage system using the --server= argument as outlined above.

Note also that anytime you must specify an object argument like host= volume= share= or others you can refer to the object by name or by its unique ID (UUID). For scripting it is always best to be more exact and use the UUID but it can be a big time-saver to be able to refer to objects by name as well, hence this capability.

Output Modes

XML Output Mode

Use --xml with any command to get the results in XML. Example:

qs disk-list --server=localhost,admin,password --xml
qs volume-list --server=localhost,admin,password

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 i

To exit the interactive command line mode simply press CTRL-C to exit.

Built-in CLI Help

All of the commands covered in the documentation are also documented within the command line utility itself. Simply run the CLI with the 'help' argument to get the full list of all the different CLI commands. This list is pretty long so it's often best to pipe it to more
qs help | more
.

You can also use the help system to get information on a specific command:

    qs help command=CMD-NAME

As an example you can get help on how to use the pool-create command like so:

    qs help command=pool-create

Another way to get information on a group of commands is to specify a category. Help will then be printed for all commands that have a partial name match to the category specified. For example, to see all the commands that have 'pool' in their name:

    qs help category=pool

Or to see all list or get commands:

    qs help category=list
    qs help category=get

In this way you can reduce down help results to just what you need.

Remote System Specification

You can use the CLI to manage remote QuantaStor systems, but in such cases you'll need to specify the IP address and username/password of the remote storage system using the 'server' argument.

qs command [--server=ipaddress[,username,password]] [command-args]
example: qs disk-list --server=192.168.0.88,admin,password --xml

Note that the 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.

Command Error Code Definitions

For all commands a 0 is returned for SUCCESS and a non-zero error code is returned if there is a command failure. Use the --xml mode to get verbose detail on the error. Full list of error codes are available here.

Usage Examples

It's always nice to see some common examples of how the CLI can be used so here's a number of commands so you can see the general syntax of how the CLI is used. You'll notice that sometimes we specify arguments with a single hyphen (-), other times with the double hyphen (--) and sometimes it is omitted. All three are supported. The only hard rule is that the command name must be the first argument after the 'qs' command-line utility name. After that the arguments can be specified in any order with or without hyphens.

    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 --server=192.168.0.88,admin,password 

Help Commands

help 
Display help for all commands. 'qs help' provides a verbose listing of all commands with their input parameters. Use 'qs help --min' for a compacted list of commands, or use 'qs help --category=<some category>' for help on aspecific category or command (for example, 'qs help --category=volume').
 qs help|h [--command=value ] [--category=value ] [--wiki=value ] [--api=value ] 
  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).
  wiki Generates help output in a format that's importable into MediaWiki.
  api Generates help output in a parsable format for automating API.


tc-commands 
List of commands for tab completion
 qs tc-commands [--command=value ] 
  command Command to show method args for.

CLI Overview

The Command Reference covers the complete list of all operations accessible via the qs CLI utility (available on Linux, Windows, and is installed within the appliance). All commands (with few exceptions) are available via the QuantaStor REST API, QuantaStor CLI, and QuantaStor Web Management interface. The CLI includes an XML output mode which can be utilized to integrate with scripts and other automated systems but for more advanced integrations we recommend using the QuantaStor REST API. CLI commands have a short name and long time. When developing scripts it is recommended to use the long command names as it makes scripts easier to read and maintain.

Command Reference

Alert Management [ALERT]

Alerts are generated by the system and routed to the administrators via the various call-home mechanisms which include email, SNMP, PagerDuty and custom alert handlers. Alerts include a severity, a descriptive message, and in most cases an identifier referring to the element of the system or grid that is the subject of the alert.

alert-clear

Deletes the alert with the specified ID.

 qs alert-clear|a-clear --id=value 
  id Unique identifier (GUID) for the object.


alert-clear-all

Clears all the alerts.

 qs alert-clear-all|a-clear-all 

alert-config-get

Alert configuration settings indicate where alert notifications should be sent.

 qs alert-config-get|ac-get 

alert-config-set

Sets the alert configuration settings such as the administrator email address, SMTP server address, etc. Be sure to use the alert-raise command to generate a test alert after you modify the alert configuration settings to ensure that emails are being properly sent.

 qs alert-config-set|ac-set [--sender-email=value ] [--smtp-server=value ] [--smtp-port=value ] [--smtp-user=value ] [--smtp-password=value ] [--smtp-auth=value ] [--support-email=value ] [--freespace-warning=value ] [--freespace-alert=value ] [--freespace-critical=value ] [--pagerduty-key=value ] 
  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-port Port number of the SMTP service (eg 25, 465, 587) where emails should be routed through (0 indicates auto-select).
  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.
  pagerduty-key Specifies the service key to which alerts will be posted to PagerDuty. Please see www.pagerduty.com for more detail on service keys.


alert-get

Gets information about a specific alert.

 qs alert-get|a-get --id=value 
  id Unique identifier (GUID) for the object.


alert-list

Returns a list of all the alerts from all systems in the grid. Adjust the settings for the 'admin' or custom user account(s) to indicate alerts to be sent out via email call-home mechanism.

 qs alert-list|a-list [--filtered=value ] 
  filtered Returns just the 'value' most recently created.


alert-raise

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

 qs alert-raise|a-raise --title=value --message=value [--alert-severity=value ] 
  title Title string to be echoed back from the server.
  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]


event-list

Returns a list of all the internal events in the event queue (used for service monitoring).

 qs event-list|ev-list [--index=value ] [--max=value ] [--time-stamp=value ] 
  index Starting event index of where to begin listing events from.
  max Maximum number of events to enumerate.
  time-stamp Time-stamp of the service.

Backup Policy Management [BACKUP-POLICY]

Backup policies provide a mechanism for scheduling and executing automatic backups of 3rd party filers and other NFS/SMB shares in an environment directly to a Network Share.

backup-job-list

Returns a list of backup jobs in the system.

 qs backup-job-list|bj-list 

backup-policy-create

Creates a ingest backup policy which pull data from NFS shares to the QuantaStor appliance.

 qs backup-policy-create|bp-create --name=value --desc=value --network-share=value --remote-hostname=value --remote-export-path=value --scan-threads=value [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  network-share Name or ID of a CIFS/NFS network share.
  remote-hostname Name of the remote host containing NFS shares to be backed up
  remote-export-path Remote export path to be mounted to access the data to be backed up.
  remote-export-type Remote mount type [*nfs, smb]
  retain-rules Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
  policy-type Backup policy type [*inbound, outbound]
  scan-threads Number of concurrent threads for walking/scanning the specified target export (Default:1,6,12,24,32,64)
  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]
  days The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  retain-period Number of days of file history on the specified filer export to backup
  purge-policy Indicates how old files should be cleaned up / purged from the backup. [after-backup, *daily, never, weekly]
  backup-to-root Indicates that the backups should go into the root folder of the Network Share.
  maintain-logs Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
  start-date 2016-12-29T00:00:00Z)
  enabled Set to enabled to activate the backup policy.
  smb-username Specifies the SMB username to use to access the specified remote filer SMB share.
  smb-password Specifies the SMB password to use to access the specified remote filer SMB share.


backup-policy-delete

Deletes the specified backup policy.

 qs backup-policy-delete|bp-delete --policy=value 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.


backup-policy-disable

Disables the specified backup policy so job are not automatically run.

 qs backup-policy-disable|bp-disable --policy=value 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.


backup-policy-enable

Enables a backup policy that was previously disabled.

 qs backup-policy-enable|bp-enable --policy=value 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.


backup-policy-get

Returns detailed information on a specific backup policy.

 qs backup-policy-get|bp-get --policy=value 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.


backup-policy-list

Returns a list of backup policies in the system.

 qs backup-policy-list|bp-list 

backup-policy-modify

Modifies the specified backup policy settings.

 qs backup-policy-modify|bp-modify --policy=value [--name=value ] [--desc=value ] [--remote-hostname=value ] [--remote-export-path=value ] [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--hours=value ] [--days=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  remote-hostname Name of the remote host containing NFS shares to be backed up
  remote-export-path Remote export path to be mounted to access the data to be backed up.
  remote-export-type Remote mount type [*nfs, smb]
  retain-rules Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
  policy-type Backup policy type [*inbound, outbound]
  scan-threads Number of concurrent threads for walking/scanning the specified target export (Default:1,6,12,24,32,64)
  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]
  days The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  retain-period retain-period
  purge-policy Indicates how old files should be cleaned up / purged from the backup. [after-backup, *daily, never, weekly]
  backup-to-root Indicates that the backups should go into the root folder of the Network Share.
  maintain-logs Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
  start-date 2016-12-29T00:00:00Z)
  enabled Set to enabled to activate the backup policy.
  smb-username Specifies the SMB username to use to access the specified remote filer SMB share.
  smb-password Specifies the SMB password to use to access the specified remote filer SMB share.


backup-policy-trigger

Triggers the specified backup policy which in turn starts a backup job.

 qs backup-policy-trigger|bp-trigger --policy=value 
  policy A backup policy name or ID which is associated with a network share to do ingest backups.

Scale-out Object / Ceph Management [CEPH]

Commands for management, monitoring, and configuration of Ceph object clusters and associated storage.

ceph-cluster-add-member

Add a new storage system to existing Ceph Cluster.

 qs ceph-cluster-add-member|cc-amn --ceph-cluster=value --storage-system=value --port=value [--public-network=value ] [--cluster-network=value ] [--enable-object-store=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  storage-system Name or ID of a storage system in a management grid.
  port Name of unique ID of a physical network port/target port.
  public-network Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
  cluster-network Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
  enable-object-store Enable ceph Object Store (if configured in the cluster. Default: false)
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-create

Create a new Ceph Cluster using the specified QuantaStor nodes(s)

 qs ceph-cluster-create|cc-create --name=value --client-interface=value --backend-interface=value [--desc=value ] [--public-network=value ] [--cluster-network=value ] [--osd-default-pool-size=value ] [--auth-cluster-required=value ] [--auth-service-required=value ] [--auth-client-required=value ] [--filestore-xattr-use-omap=value ] [--flags=value ] 
  name Name of the Ceph Cluster.
  client-interface Interface used by client to connect to ceph cluster for I/O.
  backend-interface Interface used by ceph cluster for its backend communication.
  desc A description for the object.
  public-network Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
  cluster-network Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
  osd-default-pool-size Minimum number of written replicas for objects in the pool in order to ack a write operation to the client.(default=2).
  auth-cluster-required Authentication mode for ceph cluster (default=cephx).
  auth-service-required Authentication mode for ceph services (default=cephx).
  auth-client-required Authentication mode for client managing the ceph cluster (default=cephx).
  filestore-xattr-use-omap To use object map for XATTRS. Set to true (default) for ext4 file systems.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-delete

Deletes the specified Ceph Cluster

 qs ceph-cluster-delete|cc-delete --ceph-cluster=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-fix-clock-skew

Adjusts the clocks on all the member nodes in the specified Ceph Cluster in order to address any clock skew issues.

 qs ceph-cluster-fix-clock-skew|cc-fcs --ceph-cluster=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-get

Gets information about a specific Ceph Cluster

 qs ceph-cluster-get|cc-get --ceph-cluster=value 
  ceph-cluster Ceph Cluster name or ID.


ceph-cluster-list

Returns a list of all the Ceph Clusters

 qs ceph-cluster-list|cc-list 

ceph-cluster-member-get

Gets information about a specific Ceph Cluster Member

 qs ceph-cluster-member-get|ccm-get --ceph-cluster-member=value 
  ceph-cluster-member Ceph Cluster Member name or ID.


ceph-cluster-member-list

Returns a list of all the Ceph Clusters Members

 qs ceph-cluster-member-list|ccm-list 

ceph-cluster-modify

Modify a Ceph Cluster using the specified QuantaStor nodes(s)

 qs ceph-cluster-modify|cc-modify --ceph-cluster=value [--desc=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-remove-member

Remove a storage system from an existing Ceph Cluster.

 qs ceph-cluster-remove-member|cc-rmn --ceph-cluster=value --storage-system=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-journal-create

Creates a group of Ceph Journal Devices on the specified Physical Disk.

 qs ceph-journal-create|cj-create --disk=value --storage-system=value [--device-count=value ] [--flags=value ] 
  disk Name of the physical disk or its unique ID/serial number.
  storage-system Name or ID of a storage system in a management grid.
  device-count Number of journal devices to create on the specified high performance media/SSD device. (Device count 1-8). Default is 4 if not specified
  flags Optional flags for the operation. [async, force, min, *none]


ceph-journal-delete

Deletes the specified Ceph Journal and all journal partitions on the given physical disk, if a physical disk is specified. Note: This call will fail if there are one or more Journals still being used by OSDs in the system.

 qs ceph-journal-delete|cj-delete --ceph-journal-device=value --storage-system=value [--flags=value ] 
  ceph-journal-device Ceph Journal Device name or ID.
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-journal-get

Returns details of a specific Ceph Journal Device

 qs ceph-journal-get|cj-get --ceph-journal-device=value 
  ceph-journal-device Ceph Journal Device name or ID.


ceph-journal-list

Returns a list of all the Ceph Journal Devices

 qs ceph-journal-list|cj-list 

ceph-monitor-add

Configure a new monitor for the Ceph Cluster

 qs ceph-monitor-add|cmon-add --ceph-cluster=value --ceph-cluster-member=value --ceph-cluster-monitor-ipaddress=value [--ceph-cluster-monitor-port=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-cluster-member Ceph Cluster Member name or ID.
  ceph-cluster-monitor-ipaddress IPAddress used by ceph monitor daemon for communication.
  ceph-cluster-monitor-port Port used by ceph monitor daemon for communication (default:6789).
  flags Optional flags for the operation. [async, force, min, *none]


ceph-monitor-get

Gets information about a specific Ceph Monitor

 qs ceph-monitor-get|cmon-get --ceph-monitor=value 
  ceph-monitor Ceph Monitor service name or ID.


ceph-monitor-list

Returns a list of all the Ceph Monitors

 qs ceph-monitor-list|cmon-list 

ceph-monitor-remove

Removes the specified Ceph Monitor

 qs ceph-monitor-remove|cmon-remove --ceph-cluster=value --ceph-monitor=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-monitor Ceph Monitor service name or ID.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-osd-create

Creates a new Ceph OSD on the specified storage pool

 qs ceph-osd-create|osd-create --ceph-cluster=value --data-pool=value --journal-device=value [--desc=value ] [--weight=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  data-pool Name of the storage pool or its unique ID (GUID) to allocate OSD Data store.
  journal-device Name of the storage device or its unique ID (GUID) to allocate OSD Journal store.
  desc A description for the object.
  weight Weight associated with the OSD (default 0.3).
  flags Optional flags for the operation. [async, force, min, *none]


ceph-osd-delete

Deletes the specified Ceph Osd

 qs ceph-osd-delete|osd-delete --ceph-cluster=value --ceph-osd=value [--delete-data=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-osd Ceph Object Storage Daemon name or ID.
  delete-data Flag to specify deletion of user data along with this operation. (Default : false)
  flags Optional flags for the operation. [async, force, min, *none]


ceph-osd-get

Gets information about a specific Ceph Object Storage Daemon.

 qs ceph-osd-get|osd-get --ceph-osd=value 
  ceph-osd Ceph Object Storage Daemon name or ID.


ceph-osd-list

Returns a list of all the Ceph Object Storage Daemons

 qs ceph-osd-list|osd-list 

ceph-osd-modify

Modifies the specified ceph Osd

 qs ceph-osd-modify|osd-modify --ceph-cluster=value --ceph-osd=value [--desc=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-osd Ceph Object Storage Daemon name or ID.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-osd-multi-create

Creates multiple new ceph Osd on the specified ceph cluster

 qs ceph-osd-multi-create|osd-multi-create --ceph-cluster=value --physical-disk-list=value [--journal-ssd-list=value ] [--use-unused-journal-partitions=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  physical-disk-list List of comma separated physical disk ID to be used for OSD data disks during OSD create.
  journal-ssd-list List of comma separated SSD disk ID to be used for OSD journal devices during OSD create.
  use-unused-journal-partitions Used unused journal partition on storage system for OSD create.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-create

Creates a new Ceph pool using the specified OSDs or Storage Pools

 qs ceph-pool-create|cpool-create --name=value --ceph-cluster=value [--osd-list=value ] [--desc=value ] [--placement-groups=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--crush-ruleset-name=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  ceph-cluster Ceph Cluster name or ID.
  osd-list List of one or more ceph-osd. (Default: Select all OSDs for ceph pool create). User selection is currently not supported.
  desc A description for the object.
  placement-groups Number of placement groups to assign to the Ceph pool.
  max-replicas Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
  min-replicas Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
  pool-type Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
  crush-ruleset-name Ceph crush map rule set name. (default : 'default', if not specified)
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-delete

Deletes the specified Ceph pool

 qs ceph-pool-delete|cpool-delete --ceph-cluster=value --ceph-pool=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-pool Ceph Pool name or ID.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-get

Gets information about a specific Ceph storage pool.

 qs ceph-pool-get|cpool-get --ceph-pool=value 
  ceph-pool Ceph Pool name or ID.


ceph-pool-list

Returns a list of all the Ceph storage pools.

 qs ceph-pool-list|cpool-list 

ceph-pool-modify

Sets the display name and/or description field for the Ceph pool.

 qs ceph-pool-modify|cpool-modify --ceph-cluster=value --ceph-pool=value [--name=value ] [--desc=value ] [--max-replicas=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-pool Ceph Pool name or ID.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  max-replicas Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-profile-create

Create a custom ceph pool profile for object or block storage.

 qs ceph-pool-profile-create|cpp-create --ceph-pool-profile=value --ceph-cluster=value --ceph-data-chunk-count=value --ceph-code-chunk-count=value [--desc=value ] [--ceph-profile-failure-domain=value ] [--ceph-profile-technique=value ] [--ceph-profile-plugin=value ] [--flags=value ] 
  ceph-pool-profile Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
  desc A description for the object.
  ceph-cluster Ceph Cluster name or ID.
  ceph-data-chunk-count Data chunk count for erasure coded ceph pool.
  ceph-code-chunk-count checksum (code) chunk count for erasure coded ceph pool.
  ceph-profile-failure-domain Failure domain for the ceph pool {Default: host}.
  ceph-profile-technique Erasure coding technique for ceph pool. {Default: reed-solomon-van}
  ceph-profile-plugin ceph plugin used for erasure coded pool {Default: jerasure}
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-profile-delete

Deletes the specified ceph pool profile.

 qs ceph-pool-profile-delete|cpp-delete --ceph-pool-profile=value [--flags=value ] 
  ceph-pool-profile Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-pool-profile-get

Gets information about a specific ceph pool profile.

 qs ceph-pool-profile-get|cpp-get --ceph-pool-profile=value [--flags=value ] 
  ceph-pool-profile Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
  flags Optional flags for the operation. [min]


ceph-pool-profile-list

Returns a list of all the ceph pool profile(s) present in the cluster.

 qs ceph-pool-profile-list|cpp-list --ceph-cluster=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


ceph-rbd-create

Creates a new Ceph block device (RBD) in the specified Ceph pool.

 qs ceph-rbd-create|rbd-create --name=value --ceph-cluster=value --ceph-pool=value --size=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  ceph-cluster Ceph Cluster name or ID.
  ceph-pool ceph-pool
  size Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-rbd-delete

Deletes the specified Ceph block device (RBD)

 qs ceph-rbd-delete|rbd-delete --ceph-cluster=value --ceph-rbd=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-rbd Ceph RBD/Block Device name or ID.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-rbd-get

Gets information about a specific Ceph RDB / block device

 qs ceph-rbd-get|rbd-get --ceph-rbd=value 
  ceph-rbd Ceph RBD/Block Device name or ID.


ceph-rbd-list

Returns a list of all the Ceph RDB / block devices.

 qs ceph-rbd-list|rbd-list 

ceph-rbd-modify

Sets the display name and/or description field for the Ceph block device (RBD).

 qs ceph-rbd-modify|rbd-modify --ceph-cluster=value --ceph-rbd=value --name=value [--desc=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-rbd Ceph RBD/Block Device name or ID.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-rbd-resize

Resizes the specified Ceph block device (RBD) to a larger size.

 qs ceph-rbd-resize|rbd-resize --ceph-cluster=value --ceph-rbd=value --size=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-rbd Ceph RBD/Block Device name or ID.
  size Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  flags Optional flags for the operation. [async, force, min, *none]


ceph-rbd-snapshot

Creates an instant snapshot of the specified Ceph block device (RBD)

 qs ceph-rbd-snapshot|rbd-snap --ceph-cluster=value --ceph-rbd=value --name=value [--desc=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-rbd Ceph RBD/Block Device name or ID.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]

Cloud Backup Schedule Management [CLOUD-BACKUP]

Cloud Backup schedules provide a mechanism for automatic backups of storage volumes into remote S3/SWIFT object storage.

cloud-backup-schedule-create

Creates a new schedule to automate backups to a cloud backup container.

 qs cloud-backup-schedule-create|cbs-create --name=value --container=value [--volume-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--max-backups=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  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.
  volume-list A list of one or more storage volumes.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  max-backups Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
  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]


cloud-backup-schedule-delete

Deletes the specified cloud backup schedule.

 qs cloud-backup-schedule-delete|cbs-delete --backup-sched=value [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  flags Optional flags for the operation. [async, force]


cloud-backup-schedule-disable

Disables a cloud backup schedule so that it does not trigger backups.

 qs cloud-backup-schedule-disable|cbs-disable --backup-sched=value [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  flags Optional flags for the operation. [async, force]


cloud-backup-schedule-enable

Enables a cloud backup schedule that was previously disabled.

 qs cloud-backup-schedule-enable|cbs-enable --backup-sched=value [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  flags Optional flags for the operation. [async, force]


cloud-backup-schedule-get

Gets detailed information about a specific cloud backup schedule.

 qs cloud-backup-schedule-get|cbs-get --backup-sched=value 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.


cloud-backup-schedule-list

Lists all the cloud backup schedules in the system.

 qs cloud-backup-schedule-list|cbs-list 

cloud-backup-schedule-modify

Modifies the settings for the specified cloud backup schedule.

 qs cloud-backup-schedule-modify|cbs-modify --backup-sched=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--container=value ] [--max-backups=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  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.
  max-backups Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
  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]


cloud-backup-schedule-trigger

Immediately triggers the specified cloud backup schedule to start a backup.

 qs cloud-backup-schedule-trigger|cbs-trigger --backup-sched=value [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  flags Optional flags for the operation. [async, force]


cloud-backup-schedule-volume-add

Adds storage volumes to an existing cloud backup schedule.

 qs cloud-backup-schedule-volume-add|cbs-v-add --backup-sched=value [--volume-list=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  volume-list A list of one or more storage volumes.


cloud-backup-schedule-volume-remove

Removes storage volumes from an existing cloud backup schedule.

 qs cloud-backup-schedule-volume-remove|cbs-v-remove --backup-sched=value [--volume-list=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  volume-list A list of one or more storage volumes.

Cloud Container Management [CLOUD-CONTAINER]

Cloud containers provide a NAS gateway mechanism to bridging S3/SWIFT cloud storage to a local Network Share within an appliance.

cloud-backup-container-add

Recovers a cloud backup container that was previously removed or used with a prior installation.

 qs cloud-backup-container-add|cbc-add --provider-creds=value --encryption-key=value --storage-url=value --enable-nfs=value 
  provider-creds Credentials for accessing your cloud storage provider account. With Amazon S3 this is your 'Access Key ID' and your 'Secret Access Key'.
  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.
  enable-nfs Enable NFS sharing of the cloud container.


cloud-backup-container-create

Creates a cloud backup container into which cloud backups of storage volumes can be made.

 qs cloud-backup-container-create|cbc-create --name=value --provider-creds=value --location=value --encryption-key=value --enable-nfs=value [--desc=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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'.
  location Cloud storage provider endpoint location.
  encryption-key A passphrase which is used to encrypt all the data sent to the cloud container.
  enable-nfs Enable NFS sharing of the cloud container.


cloud-backup-container-delete

Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.

 qs cloud-backup-container-delete|cbc-delete --container=value 
  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

Disables access to the specified cloud container without having to remove it.

 qs cloud-backup-container-disable|cbc-disable --container=value 
  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

Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.

 qs cloud-backup-container-enable|cbc-enable --container=value 
  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-get

Returns detailed information on a specific cloud backup container.

 qs cloud-backup-container-get|cbc-get --container=value 
  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

Returns a list of cloud backup containers in the system.

 qs cloud-backup-container-list|cbc-list 

cloud-backup-container-modify

Modifies the specified cloud backup container settings.

 qs cloud-backup-container-modify|cbc-modify --name=value --desc=value --container=value --encryption-key=value --enable-nfs=value 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  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.
  encryption-key A passphrase which is used to encrypt all the data sent to the cloud container.
  enable-nfs Enable NFS sharing of the cloud container.


cloud-backup-container-remove

Removes the specified cloud backup container from the system but does not delete any backup data in the cloud.

 qs cloud-backup-container-remove|cbc-remove --container=value 
  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-repair

Repairs the specified cloud backup container.

 qs cloud-backup-container-repair|cbc-repair --container=value 
  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-credentials-add

Adds cloud provider credentials to enable cloud backup to cloud backup containers.

 qs cloud-backup-credentials-add|cbcred-add --provider=value --access-key=value --secret-key=value [--project-id=value ] 
  provider A cloud provider is a storage provider like Amazon S3 which QuantaStor utilizes for backup in the cloud.
  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.
  project-id The project Id provided by your cloud storage provider for accessing your cloud storage account.


cloud-backup-credentials-get

Returns information about the specified cloud provider credential.

 qs cloud-backup-credentials-get|cbcred-get --provider-creds=value 
  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

Returns a list of all the cloud provider credentials in the system. Passwords are masked.

 qs cloud-backup-credentials-list|cbcred-list 

cloud-backup-credentials-remove

Removes the specified cloud provider credentials

 qs cloud-backup-credentials-remove|cbcred-remove --provider-creds=value 
  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-provider-get

Returns detailed information about the specified cloud provider.

 qs cloud-backup-provider-get|cbp-get --provider=value 
  provider A cloud provider is a storage provider like Amazon S3 which QuantaStor utilizes for backup in the cloud.


cloud-backup-provider-list

Returns the list of supported cloud providers.

 qs cloud-backup-provider-list|cbp-list 

Physical Disk Management [DISK]

Physical disks are storage devices (SATA, SAS, nVME, SSD, HW RAID LVs, etc) that appear to the underlying QuantaStor operating system which can then be used to form storage pools.

disk-get

Gets information about a specific physical disk.

 qs disk-get|pd-get --disk=value 
  disk Name of the physical disk or its unique ID/serial number.


disk-global-spare-add

Adds one or more dedicated hotspares to the global hotspare pool.

 qs disk-global-spare-add|hsm-add --disk-list=value [--flags=value ] 
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  flags Optional flags for the operation. [async, force, min, *none]


disk-global-spare-marker-cleanup

Cleans up invalid marker records for the dedicated hotspare physical disks in the global hot-spare pool.

 qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] 
  flags Optional flags for the operation. [async, force, min, *none]


disk-global-spare-marker-delete

Deletes the specified global hotspare marker object.

 qs disk-global-spare-marker-delete|hsm-del --name=value [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  flags Optional flags for the operation. [async, force, min, *none]


disk-global-spare-marker-get

Returns information about the specified global hotspare marker object.

 qs disk-global-spare-marker-get|hsm-get --name=value [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  flags Optional flags for the operation. [min]


disk-global-spare-marker-list

Enumerates marker records for the dedicated hotspare physical disks in the global hot-spare pool.

 qs disk-global-spare-marker-list|hsm-list [--flags=value ] 
  flags Optional flags for the operation. [min]


disk-global-spare-remove

Removes one or more dedicated hotspares from the global hotspare pool.

 qs disk-global-spare-remove|hsm-remove --disk-list=value [--flags=value ] 
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  flags Optional flags for the operation. [async, force, min, *none]


disk-identify

Pulses the disk activity light so that the specified disk can be identified in the chassis.

 qs disk-identify|pd-id --disk=value [--pattern=value ] [--duration=value ] 
  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 pulse, d = short delay, D = long delay, ex: pattern=pppD
  duration Duration in seconds to repeat the disk identification pattern.


disk-list

Enumerates all physical disks.

 qs disk-list|pd-list 

disk-scan

Scans for any new physical disks that may have been hot-plugged into the storage system.

 qs disk-scan|pd-scan [--storage-system=value ] 
  storage-system Name or ID of a storage system in a management grid.


disk-spare-list

Enumerates dedicated hotspare physical disks in the global hotspare pool.

 qs disk-spare-list|pd-spare-list [--flags=value ] 
  flags Optional flags for the operation. [min]


path-list

Enumerates all physical disk paths for multi-path devices.

 qs path-list|pdp-list 

Scale-out NAS / Gluster Management [GLUSTER]

Commands for the management and creation of scale-out Network Shares which uses integrated GlusterFS technology.

gluster-brick-get

Gets information about a specific Gluster brick.

 qs gluster-brick-get|gb-get --gluster-brick=value 
  gluster-brick Name or ID of a Gluster brick


gluster-brick-list

Returns a list of all the Gluster bricks

 qs gluster-brick-list|gb-list 

gluster-ha-intf-get

Returns a list of all the Gluster HA failover interface definitions.

 qs gluster-ha-intf-get|gi-get --ha-interface=value 
  ha-interface High-availability interface for a specific Gluster Volume.


gluster-ha-intf-list

Gets information about a specific Gluster HA failover interface definition.

 qs gluster-ha-intf-list|gi-list 

gluster-peer-get

Gets information about a specific Gluster peer system

 qs gluster-peer-get|gp-get --gluster-peer=value 
  gluster-peer Name or ID of the Gluster peer


gluster-peer-list

Returns a list of all the Gluster peer systems.

 qs gluster-peer-list|gp-list 

gluster-volume-add-bricks

Adds one or more bricks on the specified volume.

 qs gluster-volume-add-bricks|gv-add-bricks --gluster-volume=value --pool-list=value --restripe-volume=value [--flags=value ] 
  gluster-volume Name or ID of the Gluster volume
  pool-list List of one or more storage pools.
  restripe-volume Restripe files across the new Gluster bricks
  flags Optional flags for the operation. [async, force, min, *none]


gluster-volume-create

Create a new Gluster volume with new Bricks on the specified Storage Pools.

 qs gluster-volume-create|gv-create --name=value --pool-list=value --replica-count=value --disperse-count=value --stripe-volume=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  pool-list List of one or more storage pools.
  replica-count Number of replica copies to have of each file in the Gluster volume (1 = no redundancy, 2 = mirroring)
  disperse-count Dispersed is a parity based volume layout similar to RAID5 (disperse 5 = 4 data + 1 parity, disperse 3 = 2 data + 1 parity). Optionally supply a replica count to indicate the number of parity bricks per stripe where 2 is like RAID6 and 1 is like RAID5.
  stripe-volume Enable striping of files across Gluster bricks
  flags Optional flags for the operation. [async, force, min, *none]


gluster-volume-delete

Deletes the specified Gluster volume.

 qs gluster-volume-delete|gv-delete --gluster-volume=value 
  gluster-volume Name or ID of the Gluster volume


gluster-volume-get

Gets information about the specified Gluster volume

 qs gluster-volume-get|gv-get --gluster-volume=value 
  gluster-volume Name or ID of the Gluster volume


gluster-volume-list

Returns a list of all the Gluster volumes in the grid

 qs gluster-volume-list|gv-list 

gluster-volume-rebalance

Rebalances files across the bricks in the specified Gluster volume

 qs gluster-volume-rebalance|gv-rebalance --gluster-volume=value [--flags=value ] 
  gluster-volume Name or ID of the Gluster volume
  flags Optional flags for the operation. [async, force, min, *none]


gluster-volume-start

Starts the specified Gluster volume

 qs gluster-volume-start|gv-start --gluster-volume=value [--flags=value ] 
  gluster-volume Name or ID of the Gluster volume
  flags Optional flags for the operation. [async, force, min, *none]


gluster-volume-stop

Stops the specified Gluster volume.

 qs gluster-volume-stop|gv-stop --gluster-volume=value [--flags=value ] 
  gluster-volume Name or ID of the Gluster volume
  flags Optional flags for the operation. [async, force, min, *none]

Storage System Grid Management [GRID]

Commands for management and formation of grids of QuantaStor appliances which simplifies management and enables advanced features including HA, DR, and scale-out configurations.

grid-add

Adds the specified storage system to the management grid.

 qs grid-add|mg-add --node-ipaddress=value [--node-username=value ] [--node-password=value ] 
  node-ipaddress IP address of a storage system node.
  node-username Admin user account with permissions to add/remove nodes from the grid.
  node-password Admin user account password.


grid-assoc-get

Get general information about the associated storage system management grid.

 qs grid-assoc-get|mg-aget --storage-system=value [--grid=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  grid Name or ID of the storage system grid.
  flags Optional flags for the operation. [min]


grid-assoc-list

Returns a list of the associated storage system nodes in the grid.

 qs grid-assoc-list|mg-alist 

grid-create

Creates a new management grid. A given storage system can only be a member of one grid at a time.

 qs grid-create|mg-create --name=value [--desc=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.


grid-delete

Deletes the management grid. After the grid is deleted each node in the grid operates independently again.

 qs grid-delete|mg-delete 

grid-get

Get general information about the storage system management grid.

 qs grid-get|mg-get 

grid-get-hosts

Returns the /etc/hosts configuration file configuration for grid nodes.

 qs grid-get-hosts|mg-get-hosts 

grid-modify

Modify the management grid properties.

 qs grid-modify|mg-modify --name=value [--desc=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.


grid-remove

Removes the specified storage system from the management grid.

 qs grid-remove|mg-remove --storage-system=value 
  storage-system Name or ID of a storage system in a management grid.


grid-set-hosts

Configures the /etc/hosts configuration file on all systems to facilitate host name based gluster volume configurations.

 qs grid-set-hosts|mg-set-hosts --portid-list=value 
  portid-list List of UUIDs for the ethernet ports to be used for grid wide /etc/hosts file configuration.


grid-set-master

Sets the master node for a storage system.

 qs grid-set-master|mg-set --storage-system=value 
  storage-system Name or ID of a storage system in a management grid.

Storage Pool HA Failover Management [HA-FAILOVER]

Storage Pools based on ZFS can be made Highly-Available when formed using SAS/FC/iSCSI disks connected to two or more appliances. HA storage pools can be moved dynamically between a pair of appliances and activated HA groups will do automatic failover to ensure availability to the underlying pool and it's associated volume and shares.

ha-group-activate

Activates/enables the specified high-availability group to failover can occur on a system outage.

 qs ha-group-activate|hag-activate --ha-group=value 
  ha-group Name or UUID of a storage pool high-availability group


ha-group-create

Creates a new storage pool high-availability group.

 qs ha-group-create|hag-create --name=value --pool=value --sys-secondary=value --sys-primary=value [--desc=value ] [--ha-module=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  pool Name of the storage pool or its unique ID (GUID).
  sys-secondary Storage system associated with the failover group secondary node
  sys-primary Storage system associated with the failover group primary node
  desc A description for the object.
  ha-module Name or UUID of a storage pool high-availability module


ha-group-deactivate

Deactivates the specified high-availability group so that failover policies are disabled.

 qs ha-group-deactivate|hag-deactivate --ha-group=value 
  ha-group Name or UUID of a storage pool high-availability group


ha-group-delete

Deletes the specified high-availability group

 qs ha-group-delete|hag-delete --ha-group=value 
  ha-group Name or UUID of a storage pool high-availability group


ha-group-failover

Manually triggers a failover of the specified storage pool using the associated storage pool HA group policy.

 qs ha-group-failover|hag-failover --ha-group=value --storage-system=value [--flags=value ] 
  ha-group Name or UUID of a storage pool high-availability group
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


ha-group-get

Gets information about the specified storage pool HA group

 qs ha-group-get|hag-get --ha-group=value 
  ha-group Name or UUID of a storage pool high-availability group


ha-group-list

Returns a list of all the HA groups

 qs ha-group-list|hag-list 

ha-group-modify

Modifies the settings for the specified high-availability group

 qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-secondary=value ] [--ha-module=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] 
  ha-group Name or UUID of a storage pool high-availability group
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  sys-secondary Storage system associated with the failover group secondary node
  ha-module Name or UUID of a storage pool high-availability module
  verify-client-ips IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
  client-connectivity-check-policy Client connectivity failover policy indicates policy on when to failover if the designated IPs are not reponding to ping checks. [all-nonresponsive, *disabled, majority-nonresponsive]
  port-linkstate-policy Failover policy for Link Down ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]


ha-interface-create

Creates a new virtual network interface for the specified HA failover group.

 qs ha-interface-create|hai-create --ha-group=value --parent-port=value --ip-address=value [--netmask=value ] [--interface-tag=value ] [--desc=value ] [--gateway=value ] [--mac-address=value ] [--iscsi-enable=value ] 
  ha-group Name or UUID of a storage pool high-availability group
  parent-port Parent network port like 'eth0' which the virtual interface should be attached to. On failover the virtual interface will attach to the port with the same name on the failover/secondary node.
  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)
  interface-tag Tags are a alpha-numeric tag which is appended onto a given HA virtual interface for easy identification.
  desc A description for the object.
  gateway IP address of the network gateway
  mac-address MAC Address
  iscsi-enable Enables or disables iSCSI access to the specified port(s).


ha-interface-delete

Deletes the specified virtual network interface resource from the HA group

 qs ha-interface-delete|hai-delete --ha-interface=value 
  ha-interface Name or UUID of a storage pool high-availability virtual network interface


ha-interface-get

Gets information about the specified storage pool HA virtual network interface

 qs ha-interface-get|hai-get --ha-interface=value 
  ha-interface Name or UUID of a storage pool high-availability virtual network interface


ha-interface-list

Returns a list of all the HA interfaces on the specified group

 qs ha-interface-list|hai-list 

ha-module-get

Gets information about the specified storage pool HA module

 qs ha-module-get|ham-get --ha-module=value 
  ha-module Name or UUID of a storage pool high-availability module


ha-module-list

Returns a list of all the HA failover modules

 qs ha-module-list|ham-list 

ping-check

Pings the specified list of IP addresses and returns the list of IPs that responded to the ping check.

 qs ping-check|ping --verify-client-ips=value [--storage-system=value ] 
  verify-client-ips IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
  storage-system Name or ID of a storage system in a management grid.

Host Management [HOST]

Storage Volumes must be assigned to Host(s) before the block storage (LUNs) can be accessed. Each Host entry is identified by one or more iSCSI IQNs and/or FibreChannel WWPNs.

host-add

Modifies a host entry. The username/password fields are optional and are not yet leveraged by the QuantaStor system. Later this may be used to provide additional levels of integration such as automatic host side configuration of your iSCSI initiator.

 qs host-add|h-add --hostname=value [--iqn=value ] [--ip-address=value ] [--desc=value ] [--username=value ] [--password=value ] [--host-type=value ] [--flags=value ] 
  hostname Names may include any alpha-numeric plus '_' and '-' characters; 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-get

Gets information about a specific host.

 qs host-get|h-get --host=value 
  host Name of the host or its unique ID (GUID).


host-initiator-add

Adds an additional iSCSI host initiator IQN to the specified host.

 qs host-initiator-add|hi-add --host=value --iqn=value 
  host Name of the host or its unique ID (GUID).
  iqn IQN (iSCSI Qualified Name) of the host's iSCSI initiator


host-initiator-get

Gets information about a specific host identified by its initiator IQN.

 qs host-initiator-get|hi-get --iqn=value 
  iqn IQN (iSCSI Qualified Name) of the host's iSCSI initiator


host-initiator-list

Returns a list of all the initiators (IQN) of the specified host

 qs host-initiator-list|hi-list --host=value 
  host Name of the host or its unique ID (GUID).


host-initiator-remove

Removes a iSCSI host initiator (IQN) from the specified host.

 qs host-initiator-remove|hi-remove --host=value --iqn=value 
  host Name of the host or its unique ID (GUID).
  iqn IQN (iSCSI Qualified Name) of the host's iSCSI initiator


host-list

Returns a list of all the hosts that you have added to the QuantaStor system. Host groups allow you to assign storage to multiple host all at once. This is especially useful when you have a VMware or Windows cluster as you can assign and unassign storage to all nodes in the cluster in one operation.

 qs host-list|h-list 

host-modify

Modifies a host entry which contains a list of WWN/IQN or IB GIDs for a given host.

 qs host-modify|h-modify --host=value [--desc=value ] [--ip-address=value ] [--username=value ] [--password=value ] [--host-type=value ] [--hostname=value ] [--flags=value ] 
  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]
  hostname Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  flags Optional flags for the operation. [async]


host-remove

Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.

 qs host-remove|h-remove --host=value [--flags=value ] 
  host Name of the host or its unique ID (GUID).
  flags Optional flags for the operation. [async, force]

Host Group Management [HOST-GROUP]

Hosts can be grouped together into Host Group(s) to simplify assignment and management of Storage Volumes assigned to a cluster of hosts (eg. VMware).

host-group-create

Creates a new host group with the specified name.

 qs host-group-create|hg-create --name=value --host-list=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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-delete

Removes the specified host group.

 qs host-group-delete|hg-delete --host-group=value [--flags=value ] 
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
  flags Optional flags for the operation. [async, force]


host-group-get

Gets information about a specific host group.

 qs host-group-get|hg-get --host-group=value 
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.


host-group-host-add

Adds a host to the specified host group.

 qs host-group-host-add|hg-host-add --host-group=value --host-list=value 
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
  host-list A list of one or more hosts by name or ID.


host-group-host-remove

Removes a host from the specified host group.

 qs host-group-host-remove|hg-host-remove --host-group=value --host-list=value 
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
  host-list A list of one or more hosts by name or ID.


host-group-list

Returns a list of all the host groups.

 qs host-group-list|hg-list 

host-group-modify

Modifies the properties of a host group such as its name and/or description.

 qs host-group-modify|hg-modify --host-group=value [--name=value ] [--desc=value ] 
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.

Hardware RAID Management [HWRAID]

Integrated hardware management modules monitor, discover, correlate and manage all the key aspects of internal SAS HBAs and RAID Controllers.

hw-alarm-clear-all

Clears all the hardware alarms that have been recorded for the specified hardware RAID controller.

 qs hw-alarm-clear-all|hwa-clear-all --controller=value 
  controller Name or ID of a hardware RAID controller.


hw-alarm-get

Returns information about a specific hardware alarm.

 qs hw-alarm-get|hwa-get --id=value 
  id Unique identifier (GUID) for the object.


hw-alarm-list

Returns a list of all the current hardware alarms/alert messages generated from the controller.

 qs hw-alarm-list|hwa-list [--controller=value ] 
  controller Name or ID of a hardware RAID controller.


hw-controller-change-security-key

Change the security key for encryption on SED/FDE-enabled drives on hardware RAID controller.

 qs hw-controller-change-security-key|hwc-change-security-key --controller=value --old-security-key=value --security-key=value 
  controller Name or ID of a hardware RAID controller.
  old-security-key Prior security key on HW Controller card, for changing key, for encryption on FDE-enabled secure disk drives.
  security-key Security key on HW Controller card for encryption on FDE-enabled secure disk drives.


hw-controller-create-security-key

Create the security key for encryption on SED/FDE-enabled drives on hardware RAID controller.

 qs hw-controller-create-security-key|hwc-create-security-key --controller=value --security-key=value 
  controller Name or ID of a hardware RAID controller.
  security-key Security key on HW Controller card for encryption on FDE-enabled secure disk drives.


hw-controller-get

Returns information about a specific hardware RAID controller.

 qs hw-controller-get|hwc-get --controller=value 
  controller Name or ID of a hardware RAID controller.


hw-controller-group-get

Returns information about all the support hardware RAID controller group types.

 qs hw-controller-group-get|hwcg-get --controller-group=value 
  controller-group Name or ID of a hardware RAID controller group.


hw-controller-group-list

Returns a list of all the hardware controller groups.

 qs hw-controller-group-list|hwcg-list 

hw-controller-import-units

Scan and import foreign disks associated with RAID groups that were attached to another RAID controller or that require re-importing to the local appliance.

 qs hw-controller-import-units|hwc-import-units --controller=value 
  controller Name or ID of a hardware RAID controller.


hw-controller-list

Returns a list of all the hardware controllers.

 qs hw-controller-list|hwc-list [--controller-group=value ] 
  controller-group Name or ID of a hardware RAID controller group.


hw-controller-rescan

Rescans the hardware controller to look for new disks and RAID units.

 qs hw-controller-rescan|hwc-rescan --controller=value 
  controller Name or ID of a hardware RAID controller.


hw-disk-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.

 qs hw-disk-delete|hwd-delete --disk=value [--duration=value ] 
  disk Specifies a physical disk connected to a hardware RAID controller.
  duration Duration in seconds to repeat the disk identification pattern.


hw-disk-get

Returns information about a specific disk managed by a hardware RAID controller.

 qs hw-disk-get|hwd-get --disk=value 
  disk Specifies a physical disk connected to a hardware RAID controller.


hw-disk-identify

Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.

 qs hw-disk-identify|hwd-identify --unit=value [--duration=value ] 
  unit Name of a hardware RAID unit or it unique ID.
  duration Duration in seconds to repeat the disk identification pattern.


hw-disk-list

Returns a list of all the disks managed by the specified hardware controller.

 qs hw-disk-list|hwd-list [--controller=value ] 
  controller Name or ID of a hardware RAID controller.


hw-disk-mark-good

Marks the specified disk as 'good' or 'ready'. You can use this to correct the disk status for good disks that the controller has in 'bad' or 'failed' state.

 qs hw-disk-mark-good|hwd-mark-good --disk=value 
  disk Specifies a physical disk connected to a hardware RAID controller.


hw-disk-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.

 qs hw-disk-mark-spare|hwd-mark-spare --disk=value 
  disk Specifies a physical disk connected to a hardware RAID controller.


hw-enclosure-get

Returns information about a specific enclosure managed by the specified hardware RAID controller.

 qs hw-enclosure-get|hwe-get --enclosure=value 
  enclosure Name of a hardware RAID enclosure or it unique ID.


hw-enclosure-list

Returns a list of all the enclosures managed by the specified hardware RAID controller.

 qs hw-enclosure-list|hwe-list [--controller=value ] 
  controller Name or ID of a hardware RAID controller.


hw-unit-auto-create

Creates new hardware RAID units automatically using available disk resources according to the selection criteria.

 qs hw-unit-auto-create|hwu-auto-create --raid=value --disks-per-unit=value [--disk-category=value ] [--min-size=value ] [--max-size=value ] [--unit-count=value ] [--options=value ] [--storage-system=value ] [--flags=value ] 
  raid Hardware RAID type for a hardware RAID unit. [*AUTO, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60]
  disks-per-unit Number of disks to select for each new hardware RAID unit to be created. Example, 5 disks indicates 4d+1p when selected with RAID5 layout type.
  disk-category Any, SSD, or HDD, this allows filtering by disk type so that new hardware RAID units are created using the correct category of disks. [*ANY, HDD, SSD]
  min-size Minimum size of the disks to be selected for creation of new hardware RAID units
  max-size Maximum size of the disks to be selected for creation of new hardware RAID units, useful for limiting the selection to a specific group of drives.
  unit-count Maximum number of units to create, if 0 then all available disks will be used after filtering.
  options Special options to hardware encryption policy.
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


hw-unit-create

Creates a new hardware RAID unit using the specified controller.

 qs hw-unit-create|hwu-create --raid=value --disk-list=value [--controller=value ] [--flags=value ] 
  raid Hardware RAID type for a hardware RAID unit. [*AUTO, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60]
  disk-list Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the operation. [async, force, min, *none]


hw-unit-delete

Deletes the specified RAID unit. Note that you must first delete the Storage Pool before you delete the RAID unit.

 qs hw-unit-delete|hwu-delete --unit=value [--duration=value ] 
  unit Name of a hardware RAID unit or it unique ID.
  duration Duration in seconds to repeat the disk identification pattern.


hw-unit-encrypt

Enable hardware SED/FDE encryption for the specified hardware RAID unit.

 qs hw-unit-encrypt|hwu-encrypt --unit=value [--options=value ] 
  unit Name of a hardware RAID unit or it unique ID.
  options Special options to hardware encryption policy.


hw-unit-get

Returns information about a specific RAID unit managed by the specified hardware RAID controller.

 qs hw-unit-get|hwu-get --unit=value 
  unit Name of a hardware RAID unit or it unique ID.


hw-unit-identify

Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.

 qs hw-unit-identify|hwu-identify --unit=value [--duration=value ] 
  unit Name of a hardware RAID unit or it unique ID.
  duration Duration in seconds to repeat the disk identification pattern.


hw-unit-list

Returns a list of all the RAID units managed by the specified hardware controller.

 qs hw-unit-list|hwu-list [--controller=value ] 
  controller Name or ID of a hardware RAID controller.

License Management [LICENSE]

Commands for management of QuantaStor license keys including adding, removing and listing keys within a grid of one or more appliances.

license-activate

Activates the system using a activation key received from customer support.

 qs license-activate|lic-act --activation-key=value 
  activation-key Activation key you'll receive from customer support after you send the activation request code.


license-activate-online

Requests automatic activation via the online activation service.

 qs license-activate-online|lic-aon [--key=value ] 
  key Unique license key identifier, use license-list to get a list of these.


license-add

Adds a license key using a license key block specified in a key file. In general, you have 7 days to activate your license using online activation of activation via email. If you do not activate after the 7 days the system will continue to run but you will not be able to make configuration changes.

 qs license-add|lic-add --key-file=value [--storage-system=value ] 
  storage-system Name or ID of a storage system in a management grid.
  key-file Key file you received which contains a key block section.


license-get

Shows the current license key info, and any activation request code.

 qs license-get|lic-get [--key=value ] 
  key Unique license key identifier, use license-list to get a list of these.


license-list

Returns a list of all the registered license keys.

 qs license-list|lic-list 

license-remove

Removes the specified license key.

 qs license-remove|lic-remove --key=value 
  key Unique license key identifier, use license-list to get a list of these.

Cloud I/O Stats Management [METRICS]

Commands for the configuration and management of Librato Metrics cloud stats collection system.

metrics-get

Get the current username, token, and interval settings for Librato Metrics.

 qs metrics-get|lm-get --storage-system=value 
  storage-system Name or ID of a storage system in a management grid.


metrics-set

Set the username, token, and interval for Librato Metrics posting.

 qs metrics-set|lm-set --username=value --token=value [--storage-system=value ] [--interval=value ] [--dashboards=value ] [--alert-anno=value ] [--config-anno=value ] 
  storage-system Name or ID of a storage system in a management grid.
  username The username/email of the Librato Metrics account.
  token The API token associated with the Librato Metrics account.
  interval The interval in seconds of how often QuantaStor should post data to Librato Metrics.
  dashboards Automatically create the QuantaStor system dashboard in Librato Metrics
  alert-anno Add alert annotations to the Librato Metrics postings.
  config-anno Add config annotations to the Librato Metrics postings.

Network Share Namespace Management [NAMESPACE]

Commands for managing Network Shares Namespaces which controls NFS redirects and Microsoft DFS for the SMB protocol.

share-namespace-add-shares

Adds one or more shares to the specified Network Share Namespace.

 qs share-namespace-add-shares|nspc-add-shares --namespace=value --preferred-ports=value --share-list=value 
  namespace Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
  preferred-ports List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
  share-list A list of one or more network shares.


share-namespace-create

Creates a new Network Share Namespace which provides the ability to combine shares across appliances into a single namepace which integrates with Microsoft DFS.

 qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--enable-msdfs=value ] [--enable-nfsredir=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  preferred-ports List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
  share-list A list of one or more network shares.
  desc A description for the object.
  enable-msdfs Enables Microsoft DFS support for all shares in the namespace.
  enable-nfsredir Enables NFSv4 redirects for all shares in the namespace.
  flags Optional flags for the operation. [async, force]


share-namespace-delete

Deletes the specified Network Share Namespace, associated Network Shares are not deleted.

 qs share-namespace-delete|nspc-delete --namespace=value [--flags=value ] 
  namespace Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
  flags Optional flags for the operation. [async, force]


share-namespace-get

Returns detailed information about the specified Network Share Namespace.

 qs share-namespace-get|nspc-get --namespace=value 
  namespace Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.


share-namespace-list

Returns a list of all the Network Share Namespaces in the grid.

 qs share-namespace-list|nspc-list 

share-namespace-modify

Modifies the selected Network Share Namespace properties including name, description, and features.

 qs share-namespace-modify|nspc-modify --namespace=value [--name=value ] [--desc=value ] [--enable-msdfs=value ] [--enable-nfsredir=value ] [--flags=value ] 
  namespace Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  enable-msdfs Enables Microsoft DFS support for all shares in the namespace.
  enable-nfsredir Enables NFSv4 redirects for all shares in the namespace.
  flags Optional flags for the operation. [async]


share-namespace-remove-shares

Removes one or more shares from the specified Network Share Namespace.

 qs share-namespace-remove-shares|nspc-remove-shares --namespace=value --preferred-ports=value --share-list=value 
  namespace Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
  preferred-ports List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
  share-list A list of one or more network shares.

Storage Pool Management [POOL]

Storage Pools combined Physical Disks together to form fault-tolerant pools of storage that can be provisioned from. Both Storage Volumes and Network Shares are provisioned from Storage Pools where ZFS based pools are the default ans XFS based pools are used for scale-out configurations using Ceph or Gluster technology.

pool-add-spare

Adds a dedicated hot-spare to the specified storage pool.

 qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  flags Optional flags for the operation. [async]


pool-create

Creates a new storage pool from which storage volumes can be created.

 qs pool-create|p-create --name=value --disk-list=value [--raid-type=value ] [--pool-type=value ] [--desc=value ] [--is-default=value ] [--ssd=value ] [--compress=value ] [--nobarriers=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  raid-type RAID type for the storage pool. [*AUTO, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID6]
  pool-type The type of storage pool to be created. [btrfs, ceph, ext4, jfs, swap, *xfs, zfs]
  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 configurable settings.
  raid-set-size Then number of disks to use in each set of disks when creating a RAID50 or RAID60 storage pool.
  encrypt Enables encryption on all devices in the storage pool. Encryption can only be enabled at the time of pool creation.
  encryption-type Sets the encryption algorithm, currently only the default aes256 is supported. [aes256, *default]
  passphrase Locks up the storage keys into an encrypted file after the pool has been created. After this the passphrase must be provided to start the storage pool. If no storage pool is provided then the pool is started automatically at system startup time.
  flags Optional flags for the operation. [async]


pool-destroy

Deletes a storage pool, *WARNING* any data in the pool will be lost.

 qs pool-destroy|p-destroy --pool=value [--shred-mode=value ] [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  shred-mode Indicates the mode used to shred data on all the disks in the pool as part of the pool destroy process. [dod, nnsa, *none, random, usarmy, zeros]
  flags Optional flags for the operation. [async, force]


pool-device-get

Gets information about a specific storage pool device.

 qs pool-device-get|spd-get --name=value 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.


pool-device-list

Returns a list of all the storage pool devices.

 qs pool-device-list|spd-list 

pool-expand

Expands a storage pool after the underlying hardware RAID unit has been grown underneath.

 qs pool-expand|p-expand --pool=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [async]


pool-export

Deactivate and removes the storage pool from the storage system database so that it can be exported and used on another system.

 qs pool-export|p-export --pool=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [async]


pool-get

Gets information about a specific storage pool.

 qs pool-get|p-get --pool=value 
  pool Name of the storage pool or its unique ID (GUID).


pool-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.

 qs pool-grow|p-grow --pool=value --disk-list=value [--raid-type=value ] [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  raid-type RAID type for the storage pool. [*AUTO, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID6]
  flags Optional flags for the operation. [async]


pool-identify

Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.

 qs pool-identify|p-id --pool=value [--pattern=value ] [--duration=value ] [--flags=value ] 
  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 pulse, d = short delay, D = long delay, ex: pattern=pppD
  duration Duration in seconds to repeat the disk identification pattern.
  flags Optional flags for the operation. [async]


pool-import

Imports the named storage pool(s) which have been previously exported.

 qs pool-import|p-import --storage-system=value --pool-list=value [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  pool-list List of storage pools.
  flags Optional flags for the operation. [async]


pool-list

Returns a list of all the storage pools.

 qs pool-list|p-list 

pool-modify

Modifies the properties of the storage pool such as its name and description.

 qs pool-modify|p-modify --pool=value [--name=value ] [--is-default=value ] [--ssd=value ] [--compress=value ] [--nobarriers=value ] [--profile=value ] [--desc=value ] [--sync=value ] [--compression-type=value ] [--repair-policy=value ] [--approve-repair=value ] [--copies=value ] [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  name Names may include any alpha-numeric plus '_' and '-' characters; 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 configurable settings.
  desc A description for the object.
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  repair-policy assigned-only | assigned-and-global-exact | assigned-only-exact | manual-repair) [*assigned-and-global, assigned-and-global-exact, assigned-only, assigned-only-exact, manual]
  approve-repair Set flag to approve a pending storage pool repair action that is currently deferred and requires explicit manual approval by an operator/admin to proceed
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  flags Optional flags for the operation. [async]


pool-preimport-scan

Returns a list of pools that are available to import but that are not yet discovered.

 qs pool-preimport-scan|ppi-scan --storage-system=value [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [min]


pool-profile-get

Gets information about a specific storage pool profile.

 qs pool-profile-get|pp-get --profile=value 
  profile Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.


pool-profile-list

Returns a list of all the storage pool profiles.

 qs pool-profile-list|pp-list 

pool-remove-spare

Removes the specified hot-spare from the specified pool.

 qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited list of drives (no spaces) to be used for the operation.
  flags Optional flags for the operation. [async]


pool-scan

Rescans the specified storage system for storage pools.

 qs pool-scan|p-scan [--storage-system=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async]


pool-scrub-start

Starts a scrub/verify operation on a ZFS-based Storage Pool (verifies data integrity and auto-corrects any bit-rot).See 'zpoolscrub' command for additional control. For example, 'zpoolscrub --cron' will setup an automatic monthly scrub.

 qs pool-scrub-start|p-scrub-start --pool=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [async]


pool-scrub-stop

Stops the an active scrub/verify operation on a ZFS-based Storage Pool.

 qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [async]


pool-start

Starts up a previously stopped storage pool.

 qs pool-start|p-start --pool=value [--passphrase=value ] [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  passphrase If the Storage Pool was created with an encryption passphrase then it must be specified in order to temporarily unlock the keys and start the Storage Pool.
  flags Optional flags for the operation. [async]


pool-stop

Stops all volume activity to the pool and disables it for maintenance.

 qs pool-stop|p-stop --pool=value [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [async]

QoS Policy Management [QOSPOLICY]

Storage Volume access can be throttled to limit throughput independently for read and write IO in terms of MB/sec via Quality of Serivce (QoS) policies.

qos-policy-create

Creates a new Quality-of-Service (QoS) policy template, which is used to apply throughput performance limits on Storage Volumes.

 qs qos-policy-create|qos-create --name=value --bw-read=value --bw-write=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  bw-read Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  bw-write Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  desc A description for the object.
  flags Optional flags for the operation. [async]


qos-policy-delete

Deletes a given QoS Policy and clears the QoS performance limits on all Storage Volumes associated with the policy.

 qs qos-policy-delete|qos-delete --qos-policy=value [--flags=value ] 
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.
  flags Optional flags for the operation. [async, force]


qos-policy-get

Returns detailed information about a specific QoS policy.

 qs qos-policy-get|qos-get --qos-policy=value 
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.


qos-policy-list

Returns details on the list of all QoS policy objects in the storage system grid.

 qs qos-policy-list|qos-list 

qos-policy-modify

Modifies an existing QoS policy with a new name, description, or performance limits. Changes are applied immediately to all volumes.

 qs qos-policy-modify|qos-modify --qos-policy=value [--name=value ] [--desc=value ] [--bw-read=value ] [--bw-write=value ] [--flags=value ] 
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  bw-read Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  bw-write Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  flags Optional flags for the operation. [async]

Resource Group Quota Management [QUOTA]

Resource Groups can have quotas associated with them to limit which pools and how much storage can be provisioned from those pools by a given group of users which are members of a Resource Group

provisioning-quota-create

Creates a new storage provisioning quota on a pool for the specified tenant resource cloud.

 qs provisioning-quota-create|pq-create --name=value --pool=value --cloud=value [--policy=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  pool Name of the storage pool or its unique ID (GUID).
  cloud Name of a Storage Cloud or its unique id.
  policy Indicates the type of quota to be created. [hard, *soft]
  desc A description for the object.
  psize The total thin-provisionable space allowed by this provisioning quota.
  usize The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
  max-volumes The maximum number of volumes that can be created using this quota, specify 0 for no limit.
  max-shares The maximum number of share that can be created using this quota, specify 0 for no limit.
  flags Optional flags for the operation. [async]


provisioning-quota-delete

Deletes a storage provisioning quota, the associated volumes are not deleted.

 qs provisioning-quota-delete|pq-delete --quota=value [--flags=value ] 
  quota Name or ID of a storage provisioning quota.
  flags Optional flags for the operation. [async, force]


provisioning-quota-get

Returns information about a specific storage provisioning quota.

 qs provisioning-quota-get|pq-get --quota=value 
  quota Name or ID of a storage provisioning quota.


provisioning-quota-list

Returns a list of all the storage provisioning quotas.

 qs provisioning-quota-list|pq-list 

provisioning-quota-modify

Modifies one to change the name and/or description of a storage provisioning quota.

 qs provisioning-quota-modify|pq-modify --quota=value --cloud=value [--name=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--policy=value ] [--flags=value ] 
  quota Name or ID of a storage provisioning quota.
  cloud Name of a Storage Cloud or its unique id.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  psize The total thin-provisionable space allowed by this provisioning quota.
  usize The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
  max-volumes The maximum number of volumes that can be created using this quota, specify 0 for no limit.
  max-shares The maximum number of share that can be created using this quota, specify 0 for no limit.
  policy Indicates the type of quota to be created. [hard, *soft]
  flags Optional flags for the operation. [async]


provisioning-quota-share-add

Adds one or more shares to the specified provisioning quota.

 qs provisioning-quota-share-add|pqs-add --quota=value --share-list=value 
  quota Name or ID of a storage provisioning quota.
  share-list A list of one or more network shares.


provisioning-quota-share-assoc-list

Returns a list of all the associated provisioning quotas of a specified share.

 qs provisioning-quota-share-assoc-list|pqs-alist --share=value 
  share Name or ID of a network share.


provisioning-quota-share-remove

Removes one or more shares from the specified provisioning quota.

 qs provisioning-quota-share-remove|pqs-remove --quota=value --share-list=value 
  quota Name or ID of a storage provisioning quota.
  share-list A list of one or more network shares.


provisioning-quota-volume-add

Adds one or more volumes to the specified provisioning quota.

 qs provisioning-quota-volume-add|pqv-add --quota=value --volume-list=value 
  quota Name or ID of a storage provisioning quota.
  volume-list A list of one or more storage volumes.


provisioning-quota-volume-assoc-list

Returns a list of all the associated provisioning quotas of a specified volume.

 qs provisioning-quota-volume-assoc-list|pqv-alist --volume=value 
  volume Name of the storage volume or its unique ID (GUID).


provisioning-quota-volume-remove

Removes one or more volumes from the specified provisioning quota

 qs provisioning-quota-volume-remove|pqv-remove --quota=value --volume-list=value 
  quota Name or ID of a storage provisioning quota.
  volume-list A list of one or more storage volumes.

Remote Replication Management [REPLICATION]

Remote-replication and associated replication schedules enable automatic replication to a pool of storage in a remote appliance for disaster-recovery (DR) purposes.

replica-assoc-delete

Deletes the specified replication association between a source/target pair of volumes or shares.

 qs replica-assoc-delete|rep-assoc-delete --replica-assoc=value 
  replica-assoc Name or ID of a replica association between a source/target volume or share


replica-assoc-get

Returns details of the specified replication association.

 qs replica-assoc-get|rep-assoc-get --replica-assoc=value 
  replica-assoc Name or ID of a replica association between a source/target volume or share


replica-assoc-list

Returns a list of all the replication associations.

 qs replica-assoc-list|rep-assoc-list 

replica-assoc-rollback

Reverses the replication to send the changes on the target back to the source volume/share. Requires the --force flag.

 qs replica-assoc-rollback|rep-assoc-rollback --replica-assoc=value 
  replica-assoc Name or ID of a replica association between a source/target volume or share


replica-assoc-stop

Attempts to stop the replication process between a source/target pair of volumes or shares.

 qs replica-assoc-stop|rep-assoc-stop --replica-assoc=value 
  replica-assoc Name or ID of a replica association between a source/target volume or share


replica-assoc-sync

Restarts the replication process between a source/target pair of volumes or shares.

 qs replica-assoc-sync|rep-assoc-sync --replica-assoc=value 
  replica-assoc Name or ID of a replica association between a source/target volume or share


replication-schedule-add

Adds one or more volumes/shares to the specified schedule.

 qs replication-schedule-add|rsch-add --schedule=value [--volume-list=value ] [--share-list=value ] 
  schedule Name or ID of a replication schedule.
  volume-list A list of one or more storage volumes.
  share-list A list of one or more network shares.


replication-schedule-create

Creates a new replication schedule to replicate the specified storage volumes and shares to the specified target pool on a schedule.

 qs replication-schedule-create|rsch-create --name=value --target-pool=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-replicas=value ] [--days=value ] [--hours=value ] [--interval=value ] [--offset-minutes=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  target-pool Target storage pool on remote system to replicate to.
  volume-list A list of one or more storage volumes.
  share-list A list of one or more network shares.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  cloud Name of a Storage Cloud or its unique id.
  max-replicas Maximum number of replica snapshot checkpoints 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]
  interval Interval in minutes between replications, minimum is 15 minutes.
  offset-minutes Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
  flags Optional flags for the operation. [async]


replication-schedule-delete

Deletes a replication schedule, snapshots associated with the schedule are not removed.

 qs replication-schedule-delete|rsch-delete --schedule=value [--flags=value ] 
  schedule Name or ID of a replication schedule.
  flags Optional flags for the operation. [async, force]


replication-schedule-disable

Disables the specified replication schedule.

 qs replication-schedule-disable|rsch-disable --schedule=value [--flags=value ] 
  schedule Name or ID of a replication schedule.
  flags Optional flags for the operation. [async, force]


replication-schedule-enable

Enables the specified replication schedule.

 qs replication-schedule-enable|rsch-enable --schedule=value [--flags=value ] 
  schedule Name or ID of a replication schedule.
  flags Optional flags for the operation. [async, force]


replication-schedule-get

Returns information about a specific replication schedule.

 qs replication-schedule-get|rsch-get --schedule=value 
  schedule Name or ID of a replication schedule.


replication-schedule-list

Returns a list of all the replication schedules.

 qs replication-schedule-list|rsch-list 

replication-schedule-modify

Modifies the name, description or other properties of a replication schedule.

 qs replication-schedule-modify|rsch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-replicas=value ] [--days=value ] [--hours=value ] [--interval=value ] [--offset-minutes=value ] [--flags=value ] 
  schedule Name or ID of a replication schedule.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  cloud Name of a Storage Cloud or its unique id.
  max-replicas Maximum number of replica snapshot checkpoints 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]
  interval Interval in minutes between replications, minimum is 15 minutes.
  offset-minutes Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
  flags Optional flags for the operation. [async]


replication-schedule-remove

Removes one or more volumes/shares from the specified schedule.

 qs replication-schedule-remove|rsch-remove --schedule=value [--volume-list=value ] [--share-list=value ] 
  schedule Name or ID of a replication schedule.
  volume-list A list of one or more storage volumes.
  share-list A list of one or more network shares.


replication-schedule-trigger

Triggers the specified schedule to run immediately.

 qs replication-schedule-trigger|rsch-trigger --schedule=value [--flags=value ] 
  schedule Name or ID of a replication schedule.
  flags Optional flags for the operation. [async, force]

Resource Domain Management [RESOURCE-DOMAIN]

Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH, GlusterFS) can be automatically configured.

resource-domain-add-system

Adds one or more systems to a resource domain (site, rack, etc).

 qs resource-domain-add-system|rd-add-sys --domain-resource=value --system-list=value 
  domain-resource ID or name of a domain resource.
  system-list List of one or more systems to be associated with a resource domain.


resource-domain-assoc-get

Returns information about a system/appliance association with a specific domain (rack, building, site).

 qs resource-domain-assoc-get|rda-get [--system-resource=value ] [--resource-domain-assoc=value ] 
  system-resource Storage system to be associated to a resource domain (site, rack, building) for use in automatic CRUSH map generation.
  resource-domain-assoc Resource domain association between a system and a resource domain (site, rack, building) for use in automatic CRUSH map generation.


resource-domain-assoc-list

Returns a list of all the defined resource domain association objects which represent links between appliances to sites, buildings, and racks.

 qs resource-domain-assoc-list|rda-list 

resource-domain-create

Creates a new resource domain which identifies a site, building or rack of equipment.

 qs resource-domain-create|rd-create --name=value [--desc=value ] [--resource-type=value ] [--resource-parent=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  resource-type Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
  resource-parent Parent domain resource name or ID. For example a rack resource can have a parent resource of type site or building.
  flags Optional flags for the operation. [async]


resource-domain-delete

Deletes the specified resource domain.

 qs resource-domain-delete|rd-delete --domain-resource=value [--flags=value ] 
  domain-resource ID or name of a domain resource.
  flags Optional flags for the operation. [async, force]


resource-domain-get

Resource failure domains identify physical equipment, sites, racks so that data can be dispersed in such a way as to ensure fault-tolerance and high availability across sites and racks.

 qs resource-domain-get|rd-get --domain-resource=value 
  domain-resource ID or name of a domain resource.


resource-domain-list

Returns a list of all the defined resource domain objects which can include sites, buildings, racks, and servers.

 qs resource-domain-list|rd-list 

resource-domain-modify

Modifies an existing resource domain to change properties like name and description.

 qs resource-domain-modify|rd-modify --domain-resource=value [--name=value ] [--desc=value ] [--resource-type=value ] [--resource-parent=value ] [--flags=value ] 
  domain-resource ID or name of a domain resource.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  resource-type Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
  resource-parent Parent domain resource name or ID. For example a rack resource can have a parent resource of type site or building.
  flags Optional flags for the operation. [async]


resource-domain-rm-system

Removes one or more systems from a resource domain (site, rack, etc)

 qs resource-domain-rm-system|rd-rm-sys --domain-resource=value --system-list=value 
  domain-resource ID or name of a domain resource.
  system-list List of one or more systems to be associated with a resource domain.

Multitenant Resource Group Management [RESOURCE-GROUP]

Resource Groups combine volumes, shares, and pools of storage together and so that they can be assigned to one more users (tenants). This facilitates multi-tenancy and delegation of common tasks like storage provisioning to end-users.

resource-group-create

Creates a new tenant resource group comprised of the specified users, resources and chap information.

 qs resource-group-create|rg-create --name=value [--desc=value ] [--subject-list=value ] [--resource-list=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...
  parent-cloud The name or unique id of a tenant resource cloud.
  tier The tier of the storage cloud.
  organization The name of the organization this tenant resource cloud is assigned to.
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.
  flags Optional flags for the operation. [async, force, min, *none]


resource-group-delete

Deletes a tenant's resource group, the resources and users will not be deleted.

 qs resource-group-delete|rg-delete --cloud=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  flags Optional flags for the operation. [async, force]


resource-group-get

Returns information of the specified tenant resource groups.

 qs resource-group-get|rg-get --cloud=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  flags Optional flags for the operation. [async, force]


resource-group-list

Returns a list of all the tenant resource groups.

 qs resource-group-list|rg-list [--flags=value ] 
  flags Optional flags for the operation. [async, force]


resource-group-modify

Modifies the name, description, parent resource group, tier, organization, and chap information of a resource group.

 qs resource-group-modify|rg-modify --cloud=value [--name=value ] [--desc=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  parent-cloud The name or unique id of a tenant resource cloud.
  tier The tier of the storage cloud.
  organization The name of the organization this tenant resource cloud is assigned to.
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.
  flags Optional flags for the operation. [async, force, min, *none]


resource-group-resource-add

Add one or more resources to the specified tenant resource group.

 qs resource-group-resource-add|rgr-add --cloud=value --resource-list=value 
  cloud Name of a Storage Cloud or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...


resource-group-resource-mode

Set the mode of a specified resource in the tenant resource group.

 qs resource-group-resource-mode|rgr-mode --cloud=value --resource=value --access-mode=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  resource The unique id of a volume or volume group or share or host or host group.
  access-mode Access mode for the volume.
  flags Optional flags for the operation. [async, force, min, *none]


resource-group-resource-remove

Remove one or more resource from the specified tenant resource group.

 qs resource-group-resource-remove|rgr-remove --cloud=value --resource-list=value 
  cloud Name of a Storage Cloud or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...


resource-group-subject-assoc-list

Returns a list of associated tenant resource groups to the specified subject (user or user group).

 qs resource-group-subject-assoc-list|rgsub-alist --subject=value [--flags=value ] 
  subject The unique id of a user or user group.
  flags Optional flags for the operation. [async, force]


resource-group-user-add

Add one or more users to the specified tenant resource group.

 qs resource-group-user-add|rgu-add --cloud=value --subject-list=value 
  cloud Name of a Storage Cloud or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...


resource-group-user-remove

Remove one or more users from specified tenant resource group.

 qs resource-group-user-remove|rgu-remove --cloud=value --subject-list=value 
  cloud Name of a Storage Cloud or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...

RBAC Role Management [ROLE]

Advanced Role Based Access Controls (RBAC) allow for the creation of custom roles that limit users to specific tasks and operations within a grid or Resource Group (collection of volumes, shares, and pools).

role-add

Adds a new role to the role based access control (RBAC) system.

 qs role-add|r-add --name=value [--desc=value ] [--permissions=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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-get

Gets information about the specified role.

 qs role-get|r-get --role=value 
  role Name of a security role or its unique ID (GUID).


role-list

Returns a list of all the defined roles the RBAC system.

 qs role-list|r-list 

role-modify

Modifies the name and/or description of a role

 qs role-modify|r-modify --role=value [--name=value ] [--desc=value ] 
  role Name of a security role or its unique ID (GUID).
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.


role-permission-add

Adds additional permissions and/or permission groups to the specified role.

 qs role-permission-add|rp-add --role=value --permissions=value 
  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-def-list

Returns a list of all the defined permissions available to be assigned to roles in the RBAC system.

 qs role-permission-def-list|rpd-list 

role-permission-remove

Removes one or more permissions and/or permission groups from the specified role.

 qs role-permission-remove|rp-remove --role=value --permissions=value 
  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-remove

Removes the specified role identified by name or ID

 qs role-remove|r-remove --role=value 
  role Name of a security role or its unique ID (GUID).

Snapshot Schedule Management [SCHEDULE]

Snapshot schedules make automatic instant point-in-time snapshots of Storage Volumes and/or Network Shares on a schedule. It is highly recommended that snapshot schedule(s) be created for all mission critical volumes and shares so that data and files can be easily recovered from a previous point in time.

snap-schedule-add

Adds one or more volumes/shares to the specified schedule.

 qs snap-schedule-add|sch-add --schedule=value [--volume-list=value ] [--share-list=value ] 
  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-assoc-list

Returns a list of all the volume/share associations for a given snapshot schedule.

 qs snap-schedule-assoc-list|scha-list --schedule=value 
  schedule Name of a snapshot schedule or its unique ID (GUID).


snap-schedule-create

Creates a new snapshot schedule comprised of the specified storage volumes.

 qs snap-schedule-create|sch-create --name=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-snaps=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  cloud Name of a Storage Cloud or its unique id.
  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

Deletes a snapshot schedule, snapshots associated with the schedule are not removed.

 qs snap-schedule-delete|sch-delete --schedule=value [--flags=value ] 
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the operation. [async, force]


snap-schedule-disable

Disables the specified snapshot schedule.

 qs snap-schedule-disable|sch-disable --schedule=value [--flags=value ] 
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the operation. [async, force]


snap-schedule-enable

Enables the specified snapshot schedule.

 qs snap-schedule-enable|sch-enable --schedule=value [--flags=value ] 
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the operation. [async, force]


snap-schedule-get

Returns information about a specific snapshot schedule.

 qs snap-schedule-get|sch-get --schedule=value 
  schedule Name of a snapshot schedule or its unique ID (GUID).


snap-schedule-list

Returns a list of all the snapshot schedules.

 qs snap-schedule-list|sch-list 

snap-schedule-modify

Modifies the name, description or other properties of a snapshot schedule.

 qs snap-schedule-modify|sch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-snaps=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  schedule Name of a snapshot schedule or its unique ID (GUID).
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  cloud Name of a Storage Cloud or its unique id.
  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-remove

Removes one or more volumes/shares from the specified schedule.

 qs snap-schedule-remove|sch-remove --schedule=value [--volume-list=value ] [--share-list=value ] 
  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-trigger

Triggers the specified schedule to run immediately.

 qs snap-schedule-trigger|sch-trigger --schedule=value 
  schedule Name of a snapshot schedule or its unique ID (GUID).

iSCSI/FC Session Management [SESSION]

Commands for iSCSI/FC storage session management.

session-close

Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.

 qs session-close|sn-close --session=value 
  session iSCSI session identifier for an active iSCSI session.


session-get

Returns detailed information on a specific iSCSI session.

 qs session-get|sn-get --session=value 
  session iSCSI session identifier for an active iSCSI session.


session-list

Returns a list of all the active iSCSI sessions.

 qs session-list|sn-list [--volume=value ] [--host=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  host Name of the host or its unique ID (GUID).

Network Share Management [SHARE]

Commands for managing Network Shares which are accessible via NFS and/or the SMB protocol.

share-ad-user-group-list

Returns a list of all the users and groups in the Active Directory domain that the appliance is a member of.

 qs share-ad-user-group-list|shr-ad-ug-list --storage-system=value [--share=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-client-add

Adds a NFS client access rule for the specified network share.

 qs share-client-add|shr-cadd --share=value --filter=value [--async=value ] [--secure=value ] [--subtree=value ] [--rdonly=value ] [--options=value ] [--flags=value ] 
  share Name or ID of a network 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
  options Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
  flags Optional flags for the operation. [async, force]


share-client-get

Returns information about the specific network share NFS client access rule.

 qs share-client-get|shr-cget --share=value [--filter=value ] [--flags=value ] 
  share Name or ID of a network share.
  filter A filter string for the client
  flags Optional flags for the operation. [async, force]


share-client-list

Returns a list of NFS clients access rules for the specified network share.

 qs share-client-list|shr-clist --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-client-modify

Modifies a NFS client access rule for the specified network share.

 qs share-client-modify|shr-cmodify --share=value --filter=value [--rdonly=value ] [--secure=value ] [--async=value ] [--subtree=value ] [--options=value ] [--flags=value ] 
  share Name or ID of a network 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
  options Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
  flags Optional flags for the operation. [async, force]


share-client-remove

Removes NFS client access rule for the specified network share.

 qs share-client-remove|shr-cremove --share=value --filter=value [--flags=value ] 
  share Name or ID of a network share.
  filter A filter string for the client
  flags Optional flags for the operation. [async, force]


share-clone

Creates a full copy of the specified network share to another storage pool.

 qs share-clone|shr-clone --share=value --pool=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] 
  share Name or ID of a network share.
  pool Name of the storage pool 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.
  active Indicates that the network share should be activated.
  flags Optional flags for the operation. [async, force]


share-create

Creates a new network share accessible via NFS v3/v4 and the SMB protocol.

 qs share-create|shr-create --name=value --pool=value [--desc=value ] [--public=value ] [--active=value ] [--cifs-enable=value ] [--user-access-list=value ] [--cifs-options=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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.
  cifs-enable Enables Samba support for network share.
  user-access-list List of users with permission to access the network share for example 'user1:valid,user2:invalid,user3:none,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties.
  cifs-options CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
  space-quota Size of the quota for the network share (optional).
  space-quota-exclude-snapshots If specified there is no limit on the space utilized by snapshots of the parent share (optional).
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  disable-snap-browsing When this is true, ability to browse snapshot directories over CIFS is disabled.
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group)
  permissions Permissions settings for the share in read/write/execute format for user/group/other in the standard UNIX permissions octal format (eg 755) or rwxr--r--
  flags Optional flags for the operation. [async, force]


share-delete

Deletes the specified network share

 qs share-delete|shr-delete --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-disable

Disables/deactivates the specified network share

 qs share-disable|shr-disable --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-enable

Enables/activates the specified network share

 qs share-enable|shr-enable --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-enum-quota

Returns the user quotas for the network share.

 qs share-enum-quota --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-get

Returns information about the specified network share.

 qs share-get|shr-get --share=value 
  share Name or ID of a network share.


share-join-domain

Joins the specified Active Directory domain/realm.

 qs share-join-domain|shr-jdomain --storage-system=value --domain=value --realm=value --kdc=value --ad-admin=value --ad-password=value [--idmap-mode=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  domain The name of the domain to have the QuantaStor system join. (DOMAIN)
  realm The name of the realm that the domain is in. (DOMAIN.COM)
  kdc The name of the active directory machine.
  ad-admin The administrator account of the domain that QuantaStor is a member of.
  ad-password The password to the administrator account of the domain that QuantaStor is a member of.
  idmap-mode Specifies the Unix to Active Directory ID mapping mode (idmap config) of rid, autorid, tdb, ad, ad-rfc2307 [ad, ad-rfc2307, autorid, rid, *tdb]
  flags Optional flags for the operation. [async, force]


share-leave-domain

Leaves the current Active Directory domain.

 qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  ad-admin The administrator account of the domain that QuantaStor is a member of.
  ad-password The password to the administrator account of the domain that QuantaStor is a member of.
  flags Optional flags for the operation. [async, force]


share-list

Returns a list of all the network shares in the system.

 qs share-list|shr-list 

share-modify

Modifies the properties of the specified network share.

 qs share-modify|shr-modify --share=value [--name=value ] [--desc=value ] [--active=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--cifs-enable=value ] [--user-access-list=value ] [--group-access-list=value ] [--cifs-options=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--flags=value ] 
  share Name or ID of a network share.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  active Indicates that the network share should be activated.
  space-quota Size of the quota for the network share (optional).
  space-quota-exclude-snapshots If specified there is no limit on the space utilized by snapshots of the parent share (optional).
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  cifs-enable Enables Samba support for network share.
  user-access-list List of users with permission to access the network share for example 'user1:valid,user2:invalid,user3:none,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties.
  group-access-list List of groups with permission to access the network share for example 'DOMAIN+group1:valid,~DOMAIN+group2' prepend with tilde (~) to remove access for specific users or groups.
  cifs-options CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
  disable-snap-browsing When this is true, ability to browse snapshot directories over CIFS is disabled.
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group)
  permissions Permissions settings for the share in read/write/execute format for user/group/other in the standard UNIX permissions octal format (eg 755) or rwxr--r--
  flags Optional flags for the operation. [async]


share-restore

Restores the specified network share with the contents of the specified snapshot.

 qs share-restore|shr-restore --share=value [--flags=value ] 
  share Name or ID of a network share.
  flags Optional flags for the operation. [async, force]


share-rollback

Instant rollback of the specified network share to the specified point-in-time snapshot. Rollback is faster than the Restore operation but only works with the most recent snapshot. It use rollback with an earlier snapshot you must first remove those snapshots which were created after the desired rollback point.

 qs share-rollback|shr-rollback --share=value --share-snapshot=value [--flags=value ] 
  share Name or ID of a network share.
  share-snapshot Name or ID of a snapshot of a network share.
  flags Optional flags for the operation. [async, force]


share-snapshot

Creates and instant space efficient snapshot of the specified network share (requires Advanced Storage Pool)

 qs share-snapshot|shr-snap --share=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] 
  share Name or ID of a network share.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  active Indicates that the network share should be activated.
  flags Optional flags for the operation. [async, force]

Site Cluster Resource Management [SITE]

Configurations with floating IPs such as High-Availability pools and Gluster VIFs first require that a Site Cluster is formed. Site Clusters maintain a heart-beat and control quorum for a subset of nodes so that Virtual Interfaces can be automatically moved between nodes as necessary.

cluster-ring-create

Creates a new cluster ring configuration for the specified site. Sites can have multiple rings to improve resiliency of the cluster in the event of a network loss on a specific port or network interface.

 qs cluster-ring-create|cr-create --site=value --member-addresses=value [--ring=value ] [--bind-address=value ] 
  site A site is a group of appliances in a location.
  member-addresses IP addresses, one from each appliance, used to form a new cluster ring for cluster communication activities.
  ring Unique cluster ring number starting with 0 for the first ring in the site.
  bind-address The bind address represents the network on which cluster communication is allowed for a specific ring.


cluster-ring-delete

Deletes the specified cluster ring configuration.

 qs cluster-ring-delete|cr-delete --cluster-ring=value 
  cluster-ring A cluster ring is a communication channel for heartbeat communication and cluster resource management communication activities. Ideal site configurations have two independent rings each on separate networks. For example, a site configuration may have a cluster ring 0 on 10.0.x.x/16 and ring 1 on 10.1.x.x/16


cluster-ring-get

Returns the details about a specific cluster ring. A ring represents a communication channel for cluster heartbeat communication. Ideal cluster configurations have two rings.

 qs cluster-ring-get|cr-get --cluster-ring=value 
  cluster-ring A cluster ring is a communication channel for heartbeat communication and cluster resource management communication activities. Ideal site configurations have two independent rings each on separate networks. For example, a site configuration may have a cluster ring 0 on 10.0.x.x/16 and ring 1 on 10.1.x.x/16


cluster-ring-list

Returns a list of the cluster ring configurations.

 qs cluster-ring-list|cr-list 

cluster-ring-member-get

Returns information about the specified cluster ring member.

 qs cluster-ring-member-get|crm-get --cluster-ring=value 
  cluster-ring A cluster-ring-member represents a physical interface on a appliance used for cluster communication.


cluster-ring-member-list

Returns a list of all the cluster ring members of the site.

 qs cluster-ring-member-list|crm-list 

site-cluster-assoc-get

Returns detailed information about the specified site association.

 qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] 
  system The system with the site association.
  site-assoc A site association is a link between a system and a site.


site-cluster-assoc-list

Returns a list of all the configured site association.

 qs site-cluster-assoc-list|sca-list 

site-cluster-create

A site represents a group of appliances at a particular location. That location can span buildings but typically represents systems in close proximity to each other.

 qs site-cluster-create|sc-create --name=value --sys-list=value [--desc=value ] [--location=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  sys-list List of systems to be combined together to form a new site.
  desc A description for the object.
  location Optional description indicating the location of the storage system.
  flags Optional flags for the operation. [async]


site-cluster-delete

Deletes the specified site configuration.

 qs site-cluster-delete|sc-delete --site=value [--flags=value ] 
  site A site is a group of appliances in a location.
  flags Optional flags for the operation. [async, force]


site-cluster-get

Returns detailed information about the specified site.

 qs site-cluster-get|sc-get --site=value 
  site A site is a group of appliances in a location.


site-cluster-list

Returns a list of all the configured sites.

 qs site-cluster-list|sc-list 

site-cluster-modify

Modifies the configuration settings of a site like it's name, location or description.

 qs site-cluster-modify|sc-modify --site=value [--name=value ] [--desc=value ] [--location=value ] 
  site A site is a group of appliances in a location.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  location Optional description indicating the location of the storage system.


site-vif-create

Creates a new virtual interface for the site. Site virtual interfaces automatically float between appliances/systems to ensure availability of a management IP for a given site.

 qs site-vif-create|svr-create --site=value --parent-port=value --ip-address=value [--netmask=value ] [--mtu=value ] [--grid-vif=value ] 
  site A site is a group of appliances in a location.
  parent-port Parent network port like 'eth0' which the virtual interface should be attached. On failover the virtual interface will attach to the port with the same name on another system in the Site Cluster.
  ip-address IP address of the form x.x.x.x such as 10.0.0.10
  netmask Subnet IP mask (ex: 255.255.255.0)
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  grid-vif When true, this virtual interface will be the gridIP. The gridIP is used for grid master auto election.


site-vif-delete

Deletes the virtual interface site resource and it's associated configuration information from the cluster configuration.

 qs site-vif-delete|svr-delete --vif-resource=value 
  vif-resource A site virtual interface resource.


site-vif-get

Returns the details about the specified virtual interface cluster resource in a site.

 qs site-vif-get|svr-get --vif-resource=value 
  vif-resource A site virtual interface resource.


site-vif-list

Returns a list of all the virtual interface site resources.

 qs site-vif-list|svr-list 

Storage Provisioning Tier Management [STORAGE-TIER]

Storage Pools can be grouped into a Storage Provisioning Teir to simplify common provisioning tasks by pushing onto the system the task of selecting the optimial storage pool to provision a volume or share from based on the amount of free-space available and allocated.

storage-tier-create

Creates a new storage storage tier comprised of the specified storage pools

 qs storage-tier-create|st-create --name=value --pool-list=value [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  pool-list List of storage pools.
  desc A description for the object.
  storage-class The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
  storage-type Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SSD, SSHD, UNKNOWN]
  perf-level An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
  flags Optional flags for the operation. [async]


storage-tier-delete

Deletes the specified storage storage tier (pools are not deleted).

 qs storage-tier-delete|st-delete --tier=value [--flags=value ] 
  tier Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
  flags Optional flags for the operation. [async, force]


storage-tier-get

Returns information about a specific storage storage tier.

 qs storage-tier-get|st-get --tier=value 
  tier Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.


storage-tier-list

Returns a list of all the storage storage tiers.

 qs storage-tier-list|st-list 

storage-tier-modify

Modifies the name, description or other property of the specified storage tier.

 qs storage-tier-modify|st-modify --tier=value [--name=value ] [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] 
  tier Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  storage-class The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
  storage-type Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SSD, SSHD, UNKNOWN]
  perf-level An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.


storage-tier-pool-add

Adds one or more pools to the specified storage tier.

 qs storage-tier-pool-add|stp-add --tier=value --pool-list=value 
  tier Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
  pool-list List of storage pools.


storage-tier-pool-remove

Removes one or more pools from the specified storage tier.

 qs storage-tier-pool-remove|stp-remove --tier=value --pool-list=value 
  tier Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
  pool-list List of storage pools.

Software Controller / iSCSI SAN Adapter [SWC]

QuantaStor appliances can use iSCSI storage to form Storage Pools. To configure an appliance to automatically connect to and login to one or more storage appliances to access iSCSI block storage first add and then configure a iSCSI Software Adapter.

sw-controller-add

Adds an iSCSI SAN adapter for connecting to the specified iSCSI SAN.

 qs sw-controller-add|swc-add --ip-address=value --name=value --storage-system=value [--desc=value ] [--chap-user=value ] [--chap-pass=value ] 
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  storage-system Name or ID of a storage system in a management grid.
  desc A description for the object.
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.


sw-controller-autoconfig

Creates all necessary hosts, storage volume assignments and iSCSI SAN adapters required to connect the specified systems to the specified storage volumes.

 qs sw-controller-autoconfig|swc-autoconfig --sys-list=value --volume-list=value 
  sys-list List of one or more storage systems.
  volume-list List of one or more storage volumes.


sw-controller-get

Gets detailed information about a specific software SAN controller.

 qs sw-controller-get|swc-get --sw-controller=value 
  sw-controller Specifies the name or ID of a software SAN controller instance.


sw-controller-list

Returns a list of all the configured software SAN adapter/controllers (iSCSI, etc).

 qs sw-controller-list|swc-list 

sw-controller-remove

Removed the specified iSCSI SAN adapter

 qs sw-controller-remove|swc-remove --sw-controller=value 
  sw-controller Specifies the name or ID of a software SAN controller instance.


sw-controller-scan

Scans the specified iSCSI SAN adapter for iSCSI targets.

 qs sw-controller-scan|swc-scan --sw-controller=value 
  sw-controller Specifies the name or ID of a software SAN controller instance.


sw-controller-target

Returns the specified software controller target.

 qs sw-controller-target|swc-target --target=value 
  target The software controller target to operate against


sw-controller-target-list

Returns a list of all the discovered software controller targets.

 qs sw-controller-target-list|swc-target-list 

sw-controller-target-login

Logs into the specified targets on the specified iSCSI SAN adapter.

 qs sw-controller-target-login|swc-target-login --sw-controller=value --target-list=value 
  sw-controller Specifies the name or ID of a software SAN controller instance.
  target-list The list of targets for the software controller to operate against


sw-controller-target-logout

Logs out of the specified targets on the specified iSCSI SAN adapter.

 qs sw-controller-target-logout|swc-target-logout --sw-controller=value --target-list=value 
  sw-controller Specifies the name or ID of a software SAN controller instance.
  target-list The list of targets for the software controller to operate against


sw-disk-session

Returns the specified software disk session.

 qs sw-disk-session|swc-session --session=value 
  session The software disk session to operate against


sw-disk-session-list

Returns a list of all software disk sessions.

 qs sw-disk-session-list|swc-session-list 

Object Storage Management [SWIFT]

Commands for S3/SWIFT object storage setup and user management within a QuantaStor managed Ceph cluster.

ceph-object-pool-group-create

Creates a new Object Pool Group for the Ceph Cluster to enable S3/SWIFT object storage gateway access.

 qs ceph-object-pool-group-create|cog-create --ceph-cluster=value --name=value [--desc=value ] [--object-store-zone=value ] [--object-store-region=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--ceph-pool-profile=value ] [--sys-list=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.
  object-store-zone Ceph object storage zone. (Default: 'default')
  object-store-region Ceph object storage region. (Default: 'default')
  pool-type Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
  min-replicas Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
  max-replicas Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
  ceph-pool-profile Custom ceph pool profile name (unique within a ceph cluster) for block or object store.
  sys-list List of one or more storage systems.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-object-pool-group-delete

Deletes the specified object pool group, WARNING all associated objects in the pool group will be destroyed.

 qs ceph-object-pool-group-delete|cog-delete --ceph-object-pool-group=value [--flags=value ] 
  ceph-object-pool-group Ceph object storage pool group.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-object-pool-group-get

Returns information about a specific object storage pool group used to store S3/SWIFT object data.

 qs ceph-object-pool-group-get|cog-get --ceph-object-pool-group=value [--flags=value ] 
  ceph-object-pool-group Ceph object storage pool group.
  flags Optional flags for the operation. [min]


ceph-object-pool-group-list

Returns a list of all the object storage pool groups.

 qs ceph-object-pool-group-list|cog-list [--ceph-cluster=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


ceph-user-access-entry-create

Creates a new user access key entry to allow S3/SWIFT access to the object storage group.

 qs ceph-user-access-entry-create|cu-create --ceph-cluster=value --name=value --display-name=value [--email=value ] [--s3-access-key=value ] [--s3-secret-key=value ] [--access-permission=value ] [--user=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  display-name Display name for the user.
  email An email address of the form 'user@example.com' without the quotes.
  s3-access-key The access key for accessing your ceph Object store using S3 Interface.(Default: , generated if not specified.)
  s3-secret-key The secret key for accessing your ceph Object store using S3 Interface.(Default: , generated if not specified.)
  access-permission Ceph object storage permission (rwx, rw-, ---) [*all, delete, read, write]
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-user-access-entry-delete

Deletes the specified SWIFT/S3 user access entry.

 qs ceph-user-access-entry-delete|cu-delete --ceph-cluster=value --acl-entry=value [--delete-data=value ] [--key-delete=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  acl-entry Ceph object storage user access control entry.
  delete-data Flag to specify deletion of user data along with this operation. (Default : false)
  key-delete Flag to specify deletion of user security keys along with this operation. (Default : false)
  flags Optional flags for the operation. [async, force, min, *none]


ceph-user-access-entry-disable

Disable a previously active/enabled SWIFT/S3 user access entry.

 qs ceph-user-access-entry-disable|cu-disable --acl-entry=value [--flags=value ] 
  acl-entry Ceph object storage user access control entry.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-user-access-entry-enable

Enable a previously suspended SWIFT/S3 user access entry.

 qs ceph-user-access-entry-enable|cu-enable --acl-entry=value [--flags=value ] 
  acl-entry Ceph object storage user access control entry.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-user-access-entry-get

Returns information about a specific object storage S3/SWIFT user access entry.

 qs ceph-user-access-entry-get|cu-get --acl-entry=value [--flags=value ] 
  acl-entry Ceph object storage user access control entry.
  flags Optional flags for the operation. [min]


ceph-user-access-entry-list

Returns a list of all the Ceph Object storage user access entries / keys

 qs ceph-user-access-entry-list|cu-list --ceph-cluster=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


ceph-user-access-entry-modify

Modifies the name and permissions for a object user access S3/SWIFT entry.

 qs ceph-user-access-entry-modify|cu-modify --ceph-cluster=value --acl-entry=value [--display-name=value ] [--email=value ] [--s3-access-key=value ] [--s3-secret-key=value ] [--swift-secret-key=value ] [--user=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  acl-entry Ceph object storage user access control entry.
  display-name Display name for the user.
  email An email address of the form 'user@example.com' without the quotes.
  s3-access-key The access key for accessing your ceph Object store using S3 Interface.(Default: , generated if not specified.)
  s3-secret-key The secret key for accessing your ceph Object store using S3 Interface.(Default: , generated if not specified.)
  swift-secret-key The secret key for accessing your ceph Object store using Swift Interface. (Default: , generated if not specified.)
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the operation. [async, force, min, *none]

Storage System Management [SYSTEM]

Commands for managing all the appliance centric settings including NTP, DNS servers, hostname, ARP policies, system restart, shutdown and more.

system-get

Get general information about the storage system.

 qs system-get|sys-get [--storage-system=value ] 
  storage-system Name or ID of a storage system in a management grid.


system-list

Returns a list of all the managed storage systems. This is always a single system unless the system is a member of a management grid.

 qs system-list|sys-list 

system-metadata-recovery-point-list

Returns a list of all the available system metadata recovery points. Recovery points allow you to restore system information such as network, host, users, and other system information from a prior automatic backup.

 qs system-metadata-recovery-point-list|smrp-list [--storage-system=value ] 
  storage-system Name or ID of a storage system in a management grid.


system-modify

Modifies the name and/or description of the storage system.

 qs system-modify|sys-modify --storage-system=value [--name=value ] [--desc=value ] [--location=value ] [--domain=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  name Storage system host name may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
  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]
  bond-mode Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [lacp, *round-robin]
  ext-hostname Specifies the external hostname for the system. This is useful for creating grids of systems in the cloud like in Amazon's EC2.
  grid-port Designated port for grid communication
  ntp-servers Comma delimited list of NTP servers to assign to the appliance.
  dns-servers Comma delimited list of DNS servers to assign to the appliance.
  flags Optional flags for the operation. [async, force, min, *none]


system-platform-event

Signal the service with an event.

 qs system-platform-event|sys-pe --event-type=value --event-message=value 
  event-type The class of event that is being signaled.
  event-message The message/key of the event to signal.


system-restart

Restarts the entire storage system.

 qs system-restart|restart [--storage-system=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


system-shutdown

Shutdown the storage system.

 qs system-shutdown|shutdown [--storage-system=value ] [--service-only=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  service-only Shutdown just the management service and not the system.
  flags Optional flags for the operation. [async, force, min, *none]


system-upgrade

Upgrade to the latest version of the core packages.

 qs system-upgrade|upgrade [--storage-system=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


timezone-list

Lists all the available time zones from the system time zone table.

 qs timezone-list|tz-list [--storage-system=value ] [--search-filter=value ] 
  storage-system Name or ID of a storage system in a management grid.
  search-filter Filter the results of the time zone list to match the specified search string.


timezone-set

Sets the time zone for the specified storage appliance.

 qs timezone-set|tz-set --timezone=value [--storage-system=value ] 
  timezone System time zone, for example 'America/Los_Angeles'
  storage-system Name or ID of a storage system in a management grid.

Storage System Replication Link Management [SYSTEM-LINK]

Storage System Links are a required prerequisite before remote-replication and replication schedules can be formed to move data between any given pair of appliances in a grid.

link-create

Create a new storage system link so that storage volumes may be replicated between storage systems.

 qs link-create|sl-create --storage-system=value --remote-system=value --local-ip=value --remote-ip=value [--bw-limit=value ] [--link-type=value ] [--desc=value ] 
  storage-system Name or ID of a storage system in a management grid.
  remote-system Name or ID of a storage system in a management grid.
  local-ip IP Address of the host being added; if unspecified the service will look it up.
  remote-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-delete

Delete an existing storage system link.

 qs link-delete|sl-delete --link=value 
  link Storage system link ID or name.


link-get

Get information about the storage system link.

 qs link-get|sl-get --link=value 
  link Storage system link ID or name.


link-list

List the existing storage system remote replication links.

 qs link-list|sl-list 

link-modify

Modify the properties of the storage system link.

 qs link-modify|sl-modify --link=value --remote-ip=value [--local-ip=value ] [--desc=value ] [--bw-limit=value ] [--link-type=value ] 
  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.

Tag/Object Property Management [TAG]

Feature which allows any object within the QuantaStor system to be tagged with user custom properties (key/value pairs). Tagging is often used to facilitate multi-tenancy deployments by applying tags containing unique IDs which identify users, customers, account, tenants and more.

tag-get

Returns information on a specific tag on a specific object.

 qs tag-get|prop-get --object-id=value --tag=value 
  object-id UUID of the object to associate the tag with.
  tag Name of the tag/key for the object property. Tags are used to add custom user metadata to objects which is especially important for multi-tenant environments.


tag-list

Lists all the tags for the object with the specified object UUID.

 qs tag-list|prop-list --object-id=value 
  object-id UUID of the object to associate the tag with.


tag-set

Adds a new tag/property to the specified object, use a value of hyphen '-' to clear a previously set value.

 qs tag-set|prop-set --object-id=value --tag=value --value=value [--value-type=value ] [--object-type=value ] 
  object-id UUID of the object to associate the tag with.
  tag tag
  value value
  value-type value-type [float, int, *string, time]
  object-type object-type [disk, host, pool, share, user, user-group, *volume]

Network Interface Management [TARGET-PORT]

Commands for configuration, management and monitoring of network ports, teaming/bonding, VLAN configuration and more.

bonded-interface-create

Creates a bonded network interface by bonding/teaming together a group of one or more physical network ports.

 qs bonded-interface-create|bond-create --ip-address=value --port-list=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--desc=value ] [--bond-mode=value ] [--flags=value ] 
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  port-list List of target ports to be bonded together.
  storage-system Name or ID of a storage system in a management grid.
  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.
  desc A description for the object.
  bond-mode Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [lacp, *round-robin]
  flags Optional flags for the operation. [async, force, min, *none]


bonded-interface-delete

Deletes the specified bonded network interface.

 qs bonded-interface-delete|bond-delete --port=value 
  port Name of unique ID of a physical network port/target port.


fiber-channel-port-disable

Disables the specified fiber channel port.

 qs fiber-channel-port-disable|fcp-disable --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, min, *none]


fiber-channel-port-enable

Enables the specified fiber channel port.

 qs fiber-channel-port-enable|fcp-enable --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, min, *none]


fiber-channel-port-get

Returns information about the specified fiber channel target port.

 qs fiber-channel-port-get|fcp-get --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [min]


fiber-channel-port-list

Returns a list of all the fiber channel target ports in the system.

 qs fiber-channel-port-list|fcp-list 

infiniband-port-get

Returns information about the specified infiniband port.

 qs infiniband-port-get|ibp-get --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [min]


infiniband-port-list

Returns a list of all the infiniband ports in the system.

 qs infiniband-port-list|ibp-list 

target-port-disable

Disables the specified target port.

 qs target-port-disable|tp-disable --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, min, *none]


target-port-enable

Enables the specified target port.

 qs target-port-enable|tp-enable --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, min, *none]


target-port-get

Returns information about the specified target port.

 qs target-port-get|tp-get --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [min]


target-port-list

Returns a list of all the target ports in the system.

 qs target-port-list|tp-list 

target-port-modify

Modifies target port settings including IP address, gateway, mtu, etc.

 qs target-port-modify|tp-modify --port=value [--port-type=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--object-gateway-enable=value ] [--desc=value ] [--float-list=value ] [--bond-mode=value ] [--flags=value ] 
  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).
  object-gateway-enable Enables/disables access to the port via S3/SWIFT for object storage deployments. WARNING, turning on object storage access will block management access to the web UI for that IP address!
  desc A description for the object.
  float-list List of physical ports and/or bonded ports that the virtual interface is allowed to float between. If a physical port goes offline the system will automatically float the virtual interface to one of the online physical ports in the float list.
  bond-mode Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [lacp, *round-robin]
  flags Optional flags for the operation. [async, force, min, *none]


target-port-rescan

Discovers new target ports and/or any manual modifications made to the configuration of the target ports.

 qs target-port-rescan|tp-rescan [--storage-system=value ] [--flags=value ] 
  storage-system Name or ID of a storage system in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


target-port-restart

Restarts the specified target port.

 qs target-port-restart|tp-restart --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, min, *none]


virtual-interface-create

Creates a new virtual network interface which is linked to a physical network port.

 qs virtual-interface-create|vif-create --parent-port=value --ip-address=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--float-list=value ] [--mtu=value ] [--desc=value ] [--flags=value ] 
  parent-port Port that the virtual interface should initially be attached to.
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  storage-system Name or ID of a storage system in a management grid.
  netmask Subnet IP mask (ex: 255.255.255.0)
  gateway IP address of the network gateway
  float-list List of physical ports and/or bonded ports that the virtual interface is allowed to float between. If a physical port goes offline the system will automatically float the virtual interface to one of the online physical ports in the float list.
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


virtual-interface-delete

Deletes the specified virtual network interface.

 qs virtual-interface-delete|vif-delete --port=value 
  port Name of unique ID of a physical network port/target port.


virtual-interface-move

Moves the specified virtual network interface to a different physical network port.

 qs virtual-interface-move|vif-move --vif=value --port=value 
  vif Name of unique ID (GUID) for the virtual interface.
  port Name of unique ID of a physical network port/target port.


vlan-interface-create

Creates a new VLAN interface on the specified physical port.

 qs vlan-interface-create|vlan-create --parent-port=value --ip-address=value --vlan-id=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--vlan-qos=value ] [--mtu=value ] [--desc=value ] [--flags=value ] 
  parent-port Port that the virtual interface should initially be attached to.
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  vlan-id VLAN ID (typically 1-255)
  storage-system Name or ID of a storage system in a management grid.
  netmask Subnet IP mask (ex: 255.255.255.0)
  gateway IP address of the network gateway
  vlan-qos VLAN Quality of Service (QoS) can be in the range of 0 (lowest, default) to 7 (highest) and represents the Class of Service (CoS) user priority of the VLAN traffic.
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, min, *none]


vlan-interface-delete

Deletes the specified VLAN interface.

 qs vlan-interface-delete|vlan-delete --port=value 
  port Name of unique ID of a physical network port/target port.

Task Management [TASK]

Every configuration operation done within an appliance or across a group of appliances is represented in the system as a Task. Some long running tasks can be canceled while running and all tasks from all systems in a grid are visible and monitorable from all appliances.

task-cancel

Cancels the specified task that is in the queue or is running.

 qs task-cancel|t-cancel --task=value 
  task ID of a task.


task-clear-all

Clears all the completed and/or failed tasks from the task log so that only the running and queued tasks (if any) remain.

 qs task-clear-all|t-clear-all 

task-get

Returns information about the specified task.

 qs task-get|t-get --task=value 
  task ID of a task.


task-list

Returns a list of all the tasks including active, completed, and failed tasks. Whenever you run a command in QuantaStor it is queued in the task manager and then executed automatically once the necessary resource locks are acquired. This means that you can run commands synchronously and/or asynchronously to run multiple operations concurrently. By default the CLI waits for the task to complete so it blocks by default. You can have the CLI not wait by specifying the 'async' flag to any operation. In such cases the CLI will return immediately.

 qs task-list|t-list [--filtered=value ] 
  filtered Returns just the 'value' most recently created.


task-proceed

Some tasks (e.g., volume-snapshot) can wait for a signal part-way through the task before proceeding. In the case of volume snapshot tasks this can be used to shorten the snapshot quiesce window.

 qs task-proceed|t-proceed --task=value [--wait-for-signal=value ] 
  task ID of a task.
  wait-for-signal Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.

Trace Level Management [TRACE-LEVEL]

Debugging facility used to increase the amount of information sent to the /var/log/qs_service.log

trace-level-get

Get the current trace level that is being used for logging.

 qs trace-level-get|tl-get 

trace-level-modify

Modify the current parameters used for logging.

 qs trace-level-modify|tl-modify [--trace-level=value ] [--stdout=value ] [--trace-filter=value ] [--trace-options=value ] 
  trace-level This is the trace level you would like the system to use for logging. [always, critical, debug, debug2, *error, info, verbose, warning]
  stdout Whether or not the traces should also be logged to stdout
  trace-filter Specific classes that you would like to have elevated trace levels
  trace-options Specific options for tracing [enable-cpuinfo,disable-cpuinfo,enable-meminfo,disable-meminfo,enable-calllog,disable-calllog,enable-eventlog,disable-eventlog]

User Management [USER]

User management within an appliance is used both to facilitate access to appliance management operations as well as to create local user accounts to provide SMB access to Network Shares. Use the System Monitor role to limit users so that they cannot change the configuration of any aspect of the system except their own password.

user-add

Adds a new user account to the system. A matching console level account is created on all grid nodes but by default SSH access is not allowed. Rather, management accounts do allow the use of qs CLI commands and QuantaStor web management interface access as per the limits of the assigned user role.

 qs user-add|u-add --name=value --password=value --role=value [--first-name=value ] [--last-name=value ] [--email=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--alerts=value ] 
  name User names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  password A password for the user to use when accessing the QuantaStor management interface.
  role Name of a security role or its unique ID (GUID).
  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.
  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-get

Gets information about the specified user.

 qs user-get|u-get --user=value 
  user Name or ID (GUID) of a existing user.


user-list

Returns a list of all the users.

 qs user-list|u-list 

user-modify

Modifies the specified user name, role, and/or description.

 qs user-modify|u-modify --user=value [--role=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--lock-account=value ] [--alerts=value ] 
  user Name or ID (GUID) of a existing user.
  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'
  lock-account Set to 'true' to lock the account, 'false' to unlock the user account.
  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-password-set

Changes the password for the specified user

 qs user-password-set|passwd --user=value --new-password=value [--old-password=value ] 
  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

Removes the specified user identified by name or ID.

 qs user-remove|u-remove --user=value 
  user Name or ID (GUID) of a existing user.

User Group Management [USER-GROUP]

Users can be grouped together to simplify management of Resource Groups.

user-group-create

Creates a new storage user group comprised of the specified users.

 qs user-group-create|ug-create --name=value --user-list=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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-delete

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

 qs user-group-delete|ug-delete --user-group=value [--flags=value ] 
  user-group A group of one or more users.
  flags Optional flags for the operation. [async, force]


user-group-get

Returns information about a specific storage user group.

 qs user-group-get|ug-get --user-group=value 
  user-group A group of one or more users.


user-group-list

Returns a list of all the storage user groups.

 qs user-group-list|ug-list 

user-group-modify

Modifies the name and/or description of a storage user group.

 qs user-group-modify|ug-modify --user-group=value [--name=value ] [--desc=value ] 
  user-group A group of one or more users.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.


user-group-user-add

Adds one or more users to the specified user group.

 qs user-group-user-add|ugu-add --user-group=value --user-list=value 
  user-group A group of one or more users.
  user-list A list of one or more users.


user-group-user-remove

Removes one or more users from the specified user group

 qs user-group-user-remove|ugu-remove --user-group=value --user-list=value 
  user-group A group of one or more users.
  user-list A list of one or more users.

Storage Volume Management [VOLUME]

Commands for the management of Storage Volumes which are block devices which can be presented to Hosts via the iSCSI and/or FC protocols.

volume-clone

Creates a complete block copy of the source volume.

 qs volume-clone|v-clone --volume=value [--pool=value ] [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  pool Name of the storage pool 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-create

Creates a new storage volume in the specified storage pool.

 qs volume-create|v-create --name=value --size=value --pool=value [--desc=value ] [--percent-reserved=value ] [--access-mode=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--count=value ] [--blocksize=value ] [--qos-policy=value ] [--thin=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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.
  percent-reserved Percentage of the storage volume's total size that should be set aside as reserved space deducted from the pool's free-space (default is 0)
  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 tenant resource cloud respectively. [cloud-defaults, *disabled, 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.
  blocksize Volume block size in KB, valid values are 8, 16, 32, 64, 128. Larger values deliver higher performance for workloads with high sequential IO.
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.
  thin Thin provision (sparse allocate) the storage volume (deprecated, use percent-reserved).
  flags Optional flags for the operation. [async, force]


volume-delete

Deletes a storage volume, *WARNING* any data in the volume will be lost.

 qs volume-delete|v-delete --volume=value [--flags=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  flags Optional flags for the operation. [async, force]


volume-get

Returns information about a specific storage volume.

 qs volume-get|v-get --volume=value 
  volume Name of the storage volume or its unique ID (GUID).


volume-list

Returns a list of all the storage volumes.

 qs volume-list|v-list 

volume-modify

Modifies a the name, description or other properties of the storage volume.

 qs volume-modify|v-modify --volume=value [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--clear-snap-flag=value ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--qos-policy=value ] [--reserved=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  name Names may include any alpha-numeric plus '_' and '-' characters; 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 tenant resource cloud respectively. [cloud-defaults, *disabled, 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.
  enable-wb-cache Enables the write-back cache on the iSCSI target driver, this option uses volatile system RAM for cache and is not recommended.
  is-active-checkpoint Tags the checkpoint device so that it cannot be replicated over. Use this for DR failover and this flag is set automatically when a failover checkpoint volume has an active iSCSI session.
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T


volume-reassign-schedule

Reassigns the created by ownership for a volume and optionally it's GMT snapshots to a new replication schedule so that they can be automatically cleaned up by the new schedule.

 qs volume-reassign-schedule|v-reassign-schedule --volume=value --schedule=value [--recursive=value ] [--flags=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  schedule Name or ID of a replication schedule.
  recursive Recursively update the GMT snapshots of the specified parent storage volume.
  flags Optional flags for the operation. [async, force]


volume-resize

Re-sizes a storage volume to make it larger, volumes cannot be reduced in size.

 qs volume-resize|v-resize --volume=value --new-size=value [--flags=value ] 
  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

Restores a storage volume to a previous point in time using a previously created snapshot. The volume restore process uses a full copy technique which is much slower than the Volume Rollback operation but works with any point-in-time snapshot.

 qs volume-restore|v-restore --volume=value --snapshot=value [--flags=value ] 
  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-rollback

Does an instant rollback of a storage volume to a previous point-in-time using the most recently created snapshot volume. Rollback only works with the most recently created snapshot. To rollback using an earlier snapshot, all snapshots that were created after the snapshot to be used for rollback must be deleted. For example, volume V1 with snapshots Vt1, Vt2, Vt3 only Vt3 can be used for rollback. To use Vt1 for rollback Vt2 and Vt3 must be deleted first.

 qs volume-rollback|v-rollback --volume=value --snapshot=value [--flags=value ] 
  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-set-qos

Sets quality of service (QoS) performance maximums for IOPS and bandwidth for the specified storage volume.

 qs volume-set-qos|v-qos --volume=value [--iops-read=value ] [--iops-write=value ] [--bw-read=value ] [--bw-write=value ] [--qos-policy=value ] [--flags=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  iops-read Sets the maximum number of 4K read IOPS (I/O per second) as a Quality of Service (QoS) control on the storage volume.
  iops-write Sets the maximum number of 4K write IOPS (I/O per second) as a Quality of Service (QoS) control on the storage volume.
  bw-read Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  bw-write Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the storage volume, 0 (default) indicates unlimited.
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a storage volume which is especially useful in multi-tenant environments.
  flags Optional flags for the operation. [async, force]


volume-snapshot

Creates a space efficient copy of the source volume.

 qs volume-snapshot|v-snap --volume=value [--name=value ] [--desc=value ] [--access-mode=value ] [--count=value ] [--lazy-clone=value ] [--wait-for-signal=value ] [--flags=value ] 
  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.
  lazy-clone Delays making the snapshot volume writable until it is assigned to a host or modified in some way. This option doesn't save space but does reduce CPU and memory usage load on the system and is recommended if you're not planning to use the snapshot right away.
  wait-for-signal Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.
  flags Optional flags for the operation. [async, force]


volume-utilization-get

Returns a specific volume utilization metrics for a single volume and specific date.

 qs volume-utilization-get|vu-get --entry=value 
  entry Specifies the GUID or the name of a volume utilization entry in the form of 'VOLUMENAME:TIMESTAMP'


volume-utilization-list

Returns volume utilization information for a specific storage volume or all storage volumes if no volume is specified.

 qs volume-utilization-list|vu-list [--volume=value ] [--offset-days=value ] [--num-days=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  offset-days Offset N many days back before pulling the utilization metrics.
  num-days Number of days of utilization metrics to pull.

Storage Volume Access Control (LUN Masking) [VOLUME-ACLS]

Volume ACLs control which Hosts have access to which Storage Volumes via block protocols like FibreChannel and iSCSI. All Storage Volumes must be assigned before they can be accessed; volumes are never made publically accessible.

volume-assign

Enables access to the specific volume from the specified host.

 qs volume-assign|va-add --volume=value --host-list=value 
  volume Name of the storage volume or its unique ID (GUID).
  host-list A list of one or more hosts by name or ID.


volume-assign-list

Returns a list of all the volume to host assignments, optionally filtered by host or storage volume.

 qs volume-assign-list|va-list [--volume=value ] [--host=value ] 
  volume Name of the storage volume or its unique ID (GUID).
  host Name of the host or its unique ID (GUID).


volume-unassign

Disables access to the specific volume from the specified host.

 qs volume-unassign|va-remove --volume=value --host-list=value 
  volume Name of the storage volume or its unique ID (GUID).
  host-list A list of one or more hosts by name or ID.


volume-unassign-all

Disables all access to the specified volume, host, or host group.

 qs volume-unassign-all|va-remove-all --volume=value 
  volume Name of the storage volume or its unique ID (GUID).


widget-create

Create a new widget object

 qs widget-create|wid-create --name=value [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  flags Optional flags for the operation. [async, force, min, *none]

Storage Volume Group Management [VOLUME-GROUP]

Storage Volume Groups are a convience feature to grouping together Storage Volumes so that they can be snapshot as a set.

volume-group-clone

Creates a complete block by block copy of all volumes in the group.

 qs volume-group-clone|vg-clone --volume-group=value [--pool=value ] [--name-suffix=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] 
  volume-group A 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-create

Creates a new storage volume group comprised of the specified storage volumes

 qs volume-group-create|vg-create --name=value --volume-list=value [--desc=value ] [--flags=value ] 
  name Names may include any alpha-numeric plus '_' and '-' characters; 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-delete

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

 qs volume-group-delete|vg-delete --volume-group=value [--destroy-volumes=value ] [--flags=value ] 
  volume-group A 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-get

Returns information about a specific storage volume group.

 qs volume-group-get|vg-get --volume-group=value 
  volume-group A group of one or more storage volumes.


volume-group-list

Returns a list of all the storage volume groups.

 qs volume-group-list|vg-list 

volume-group-modify

Modifies the name and/or description of a storage volume group.

 qs volume-group-modify|vg-modify --volume-group=value [--name=value ] [--desc=value ] 
  volume-group A group of one or more storage volumes.
  name Names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  desc A description for the object.


volume-group-snapshot

Creates a space efficient copy of all volumes in the group.

 qs volume-group-snapshot|vg-snap --volume-group=value [--name-suffix=value ] [--desc=value ] [--access-mode=value ] [--count=value ] [--wait-for-signal=value ] [--flags=value ] 
  volume-group A 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.
  wait-for-signal Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.
  flags Optional flags for the operation. [async, force]


volume-group-volume-add

Adds one or more volumes to the specified volume group.

 qs volume-group-volume-add|vgv-add --volume-group=value --volume-list=value 
  volume-group A group of one or more storage volumes.
  volume-list A list of one or more storage volumes.


volume-group-volume-remove

Removes one or more volumes from the specified volume group

 qs volume-group-volume-remove|vgv-remove --volume-group=value --volume-list=value 
  volume-group A group of one or more storage volumes.
  volume-list A list of one or more storage volumes.