QuantaStor CLI Command Reference: Difference between revisions

From OSNEXUS Online Documentation Site
Jump to navigation Jump to search
← Older edit
Visual
mNo edit summary
mNo edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:cli_guide]]
[[Category:cli_guide]]
OSNEXUS QuantaStor CLI 5.10
OSNEXUS QuantaStor CLI 6.4.1
Copyright (c) 2009-2021 OSNEXUS Corporation.  All rights reserved.
Copyright (c) 2009-2024 OSNEXUS Corporation.  All rights reserved.
 
The following QuantaStor CLI command reference documentation is also available from the CLI itself by running 'qs help' and 'qs help --min'.  The 'qs' CLI is on every QuantaStor system by default and you can also install it on other systems by downloading the QS CLI package from our [https://osnexus.com/download downloads] page.


USAGE
USAGE
Line 42: Line 44:
     qs-util                    : Various system and common RAID controller utility commands
     qs-util                    : Various system and common RAID controller utility commands
     qs-zconvert                : For importing and converting foreign OpenZFS filesystems with the QuantaStor naming conventions.
     qs-zconvert                : For importing and converting foreign OpenZFS filesystems with the QuantaStor naming conventions.
COMMAND


===help===
===help===
Line 57: Line 61:
| &nbsp; || <tt>api</tt> || Generates help output in a parsable format for automating API.
| &nbsp; || <tt>api</tt> || Generates help output in a parsable format for automating API.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===tc-commands===
List of commands for tab completion
 
<pre> qs tc-commands [--command=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>command</tt> || Command to show method args for.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 69: Line 85:
Deletes the alert with the specified ID.
Deletes the alert with the specified ID.


<pre> qs alert-clear|a-clear [--filter=value ] [--ack=value ] [--flags=value ] </pre>
<pre> qs alert-clear|a-clear --filter=value [--ack=value ] [--close=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 76: Line 92:
| &nbsp; || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
| &nbsp; || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 83: Line 101:
Clears all the alerts.
Clears all the alerts.


<pre> qs alert-clear-all|a-clear-all [--ack=value ] [--flags=value ] </pre>
<pre> qs alert-clear-all|a-clear-all [--ack=value ] [--close=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
| &nbsp; || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 105: Line 125:
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.
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.


<pre> 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 ] [--slack-webhook=value ] [--mattermost-webhook=value ] [--enable-alerts=value ] [--disable-alerts=value ] [--pause-alerts=value ] [--flags=value ] </pre>
<pre> 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 ] [--pool-freespace-warning=value ] [--pool-freespace-urgent=value ] [--pool-freespace-critical=value ] [--share-freespace-warning=value ] [--share-freespace-urgent=value ] [--share-freespace-critical=value ] [--enable-syslog=value ] [--endpoints=value ] [--enable-alerts=value ] [--disable-alerts=value ] [--pause-alerts=value ] [--snmp-user=value ] [--snmp-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 122: Line 142:
| &nbsp; || <tt>support-email</tt> || Email address for local customer support.
| &nbsp; || <tt>support-email</tt> || Email address for local customer support.
|-
|-
| &nbsp; || <tt>freespace-warning</tt> || The percentage of free-space left in a pool at which a warning is sent to indicate pool growth plans should be made.
| &nbsp; || <tt>pool-freespace-warning</tt> || The percentage (default=30) of free-space left in a pool at which a warning is sent to indicate pool growth plans should be made.
|-
| &nbsp; || <tt>pool-freespace-urgent</tt> || The percentage (default=10) of free-space left in a pool at which alerts are generated.
|-
| &nbsp; || <tt>pool-freespace-critical</tt> || The percentage (default=5) of free-space left in a pool at which all provisioning operations are blocked.
|-
|-
| &nbsp; || <tt>freespace-alert</tt> || The percentage (default=10) of free-space left in a pool at which alerts are generated.
| &nbsp; || <tt>share-freespace-warning</tt> || The percentage (default=20) of free-space left in a share quota at which a 'warning' alert is raise to indicate the share is low on space.
|-
|-
| &nbsp; || <tt>freespace-critical</tt> || The percentage (default=5) of free-space left in a pool at which all provisioning operations are blocked.
| &nbsp; || <tt>share-freespace-urgent</tt> || The percentage (default=10) of free-space left in a share quota at which a 'urgent' alert is generated.
|-
|-
| &nbsp; || <tt>pagerduty-key</tt> || Specifies the service key to which alerts will be posted to PagerDuty.  Please see www.pagerduty.com for more detail on service keys.
| &nbsp; || <tt>share-freespace-critical</tt> || The percentage (default=5) of free-space left in a share quota at which a 'critically low' alert is raised and writes will soon begin to be blocked.
|-
|-
| &nbsp; || <tt>slack-webhook</tt> || Slack.com webhook URL for alert messages to be posted to via the Slack webhook API.
| &nbsp; || <tt>enable-syslog</tt> || Enable alerts appended to '/var/log/syslog'.
|-
|-
| &nbsp; || <tt>mattermost-webhook</tt> || Mattermost.org webhook URL for alert messages to be posted to via the Mattermost incoming webhook API.
| &nbsp; || <tt>endpoints</tt> || Add new endpoints by specifying a comma delimited list in the format "module:endpointurl,module:endpointurl" and use the ~ prefix to remove entries.
|-
|-
| &nbsp; || <tt>enable-alerts</tt> || Enables previously disabled alerts, use '*' to enable all disabled alert triggers.
| &nbsp; || <tt>enable-alerts</tt> || Enables previously disabled alerts, use '*' to enable all disabled alert triggers.
Line 140: Line 164:
| &nbsp; || <tt>pause-alerts</tt> || Pauses the specified alert types/triggers for 30 days.
| &nbsp; || <tt>pause-alerts</tt> || Pauses the specified alert types/triggers for 30 days.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>snmp-user</tt> || SNMP User name
|-
| &nbsp; || <tt>snmp-password</tt> || SNMP User password
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 159: Line 187:
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.
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.


<pre> qs alert-list|a-list [--filter=value ] [--filtered=value ] [--flags=value ] </pre>
<pre> qs alert-list|a-list [--filter=value ] [--ack=value ] [--close=value ] [--filtered=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>filter</tt> || Specify a comma delimited list of one or more Alerts to be removed/cleared.  Alerts may be identified by UUID or by strings which will be matched against the title and description text.
| &nbsp; || <tt>filter</tt> || Specify a comma delimited list of one or more Alerts to be removed/cleared.  Alerts may be identified by UUID or by strings which will be matched against the title and description text.
|-
| &nbsp; || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
| &nbsp; || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
|-
| &nbsp; || <tt>filtered</tt> || Returns just the 'value' most recently created.
| &nbsp; || <tt>filtered</tt> || Returns just the 'value' most recently created.
Line 182: Line 214:
| &nbsp; || <tt>alert-severity</tt> || Severity of the user generated alert to be raise. [always, critical, error, *info, warning]
| &nbsp; || <tt>alert-severity</tt> || Severity of the user generated alert to be raise. [always, critical, error, *info, warning]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 203: Line 235:
<pre> qs alert-type-list|at-list [--flags=value ] </pre>
<pre> qs alert-type-list|at-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
===audit-log-list===
List audit log entries from the specified Storage System.
<pre> qs audit-log-list|audit-list [--max-entries=value ] [--storage-system=value ] [--audit-user=value ] [--audit-entry-types=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>max-entries</tt> || Maximum number of audit log entries to return, default 100.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>audit-user</tt> || Only gather audit entries associated with the specified user UUID.
|-
| &nbsp; || <tt>audit-entry-types</tt> || Only gather audit entries of the specified type [alert, api, message, *none, task]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 256: Line 306:
Creates a Backup Policy which can copy/move data to from NAS shares and Cloud Containers.
Creates a Backup Policy which can copy/move data to from NAS shares and Cloud Containers.


<pre> qs backup-policy-create|bp-create --name=value --network-share=value --remote-hostname=value [--remote-export-path=value ] [--remote-export-type=value ] [--desc=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--flags=value ] </pre>
<pre> qs backup-policy-create|bp-create --name=value --network-share=value --remote-hostname=value [--remote-export-path=value ] [--remote-export-type=value ] [--desc=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-mode=value ] [--filter-string=value ] [--size-threshold=value ] [--auto-copy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 321: Line 371:
| &nbsp; || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
| &nbsp; || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>force-remove-tiered</tt> || Links are created once a day. Using this option will force creation of links on every trigger.
|-
| &nbsp; || <tt>remote-export-sub-path</tt> || Destination sub-directory.
|-
| &nbsp; || <tt>filter-mode</tt> || Filter files based on the mode and the filter string matching. [exclude, include, *none]
|-
| &nbsp; || <tt>filter-string</tt> || Filter any files which contain the specified pattern from the backup policy. See 'Filter Mode'.
|-
| &nbsp; || <tt>size-threshold</tt> || The minimum size for a file to be included in the backup.
|-
| &nbsp; || <tt>auto-copy</tt> || Supplies real-time data protection by automatically copying files to a destination share.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 333: Line 395:
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 345: Line 407:
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 357: Line 419:
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 386: Line 448:
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 ] [--remote-hostname=value ] [--remote-export-path=value ] [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--flags=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 ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-mode=value ] [--filter-string=value ] [--size-threshold=value ] [--auto-copy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 429: Line 491:
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>retain-period</tt> || retain-period
| &nbsp; || <tt>retain-period</tt> || Max age of files in days until they are purged (default: 0 / never delete files).
|-
|-
| &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]
Line 451: Line 513:
| &nbsp; || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
| &nbsp; || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>force-remove-tiered</tt> || Links are created once a day. Using this option will force creation of links on every trigger.
|-
| &nbsp; || <tt>remote-export-sub-path</tt> || Destination sub-directory.
|-
| &nbsp; || <tt>filter-mode</tt> || Filter files based on the mode and the filter string matching. [exclude, include, *none]
|-
| &nbsp; || <tt>filter-string</tt> || Filter any files which contain the specified pattern from the backup policy. See 'Filter Mode'.
|-
| &nbsp; || <tt>size-threshold</tt> || The minimum size for a file to be included in the backup.
|-
| &nbsp; || <tt>auto-copy</tt> || Supplies real-time data protection by automatically copying files to a destination share.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 463: Line 537:
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
| &nbsp; || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 491: Line 565:
Creates a new S3 bucket in the specified Ceph Cluster.
Creates a new S3 bucket in the specified Ceph Cluster.


<pre> qs bucket-create|b-create --name=value --ceph-cluster=value --s3-user=value [--bucket-acl=value ] [--quota-size=value ] [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-nfs=value ] [--estimated-objects=value ] [--flags=value ] </pre>
<pre> qs bucket-create|b-create --name=value --s3-user=value [--ceph-cluster=value ] [--bucket-acl=value ] [--quota-size=value ] [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--estimated-objects=value ] [--count=value ] [--integration-options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>bucket-acl</tt> || Indicates the type of user access provided to the bucket. [auth-read, *private, public-read, public-read-write]
| &nbsp; || <tt>bucket-acl</tt> || Indicates the type of user access provided to the bucket. [auth-read, *private, public-read, public-read-write]
Line 507: Line 581:
|-
|-
| &nbsp; || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
| &nbsp; || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
|-
| &nbsp; || <tt>enable-lifecycle-policy</tt> || Enables life cycle policy on the bucket.
|-
| &nbsp; || <tt>lifecycle-policy-days</tt> || The number of life cycle policy days for objects in the given bucket.
|-
|-
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
|-
| &nbsp; || <tt>estimated-objects</tt> || Estimated number objects in the bucket based on a 4MB object size. [100M, 10M, 1B, 1M, 500M, 50M, Dynamic]
| &nbsp; || <tt>estimated-objects</tt> || Estimated number objects in the bucket based on a 4MB object size. [100M, 10M, 1B, 1M, 500M, 50M, Dynamic]
|-
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
|-
| &nbsp; || <tt>integration-options</tt> || Enable/disable quantastor thrid party integrations. [*none, veeam]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 519: Line 601:
Deletes the specified S3 bucket and all objects contained within.
Deletes the specified S3 bucket and all objects contained within.


<pre> qs bucket-delete|b-delete --bucket=value [--ceph-cluster=value ] [--cleanup-orphans=value ] [--flags=value ] </pre>
<pre> qs bucket-delete|b-delete --bucket-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>bucket</tt> || Name or ID of an S3 object storage bucket.
| &nbsp; || <tt>bucket-list</tt> || Comma delimited list of the Names or IDs of S3 Object Storage Buckets.
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>cleanup-orphans</tt> || Scan for and remove any orphan rados objects from the .rgw.bucket.data pool
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 561: Line 641:
Modify the bucket attributes.
Modify the bucket attributes.


<pre> qs bucket-modify|b-modify --bucket=value [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-nfs=value ] [--flags=value ] </pre>
<pre> qs bucket-modify|b-modify --bucket=value [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--integration-options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 569: Line 649:
|-
|-
| &nbsp; || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
| &nbsp; || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
|-
| &nbsp; || <tt>enable-lifecycle-policy</tt> || Enables life cycle policy on the bucket.
|-
| &nbsp; || <tt>lifecycle-policy-days</tt> || The number of life cycle policy days for objects in the given bucket.
|-
|-
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
| &nbsp; || <tt>integration-options</tt> || Enable/disable quantastor thrid party integrations. [*none, veeam]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 602: Line 688:




===ceph-cluster-add-member===
===bucket-search===
Add a new Storage System to existing Ceph Cluster.
Searches for a bucket based on a set of parameters.


<pre> qs ceph-cluster-add-member|cc-amn --ceph-cluster=value --storage-system=value --port=value [--public-network=value ] [--cluster-network=value ] [--flags=value ] </pre>
<pre> qs bucket-search|b-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>search-filter</tt> || Filter the results of the bucket List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
 
 
===ceph-cluster-add-member===
Add a new Storage System to existing Ceph Cluster.
 
<pre> qs ceph-cluster-add-member|cc-amn --ceph-cluster=value --storage-system=value --port=value [--public-network=value ] [--cluster-network=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|-
| &nbsp; || <tt>public-network</tt> || Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
| &nbsp; || <tt>public-network</tt> || Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
Line 618: Line 720:
| &nbsp; || <tt>cluster-network</tt> || Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
| &nbsp; || <tt>cluster-network</tt> || Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 625: Line 727:
Create a new Ceph Cluster using the specified Storage System(s).
Create a new Ceph Cluster using the specified Storage System(s).


<pre> qs ceph-cluster-create|cc-create --name=value --client-ips=value --backend-ips=value [--desc=value ] [--domain-suffix=value ] [--public-network=value ] [--cluster-network=value ] [--cluster-auth-mode=value ] [--osd-out-subtree-limit=value ] [--enable-osd-encryption=value ] [--enable-osd-compression=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--flags=value ] </pre>
<pre> qs ceph-cluster-create|cc-create --name=value --client-ips=value [--backend-ips=value ] [--desc=value ] [--domain-suffix=value ] [--public-network=value ] [--cluster-network=value ] [--cluster-auth-mode=value ] [--osd-out-subtree-limit=value ] [--enable-osd-encryption=value ] [--encryption-mode=value ] [--enable-osd-compression=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--key-server-profile=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 632: Line 734:
| &nbsp; || <tt>client-ips</tt> || List of IP addresses used to identify which systems and which ports to use for the Ceph Cluster front-end/client communication ports.
| &nbsp; || <tt>client-ips</tt> || List of IP addresses used to identify which systems and which ports to use for the Ceph Cluster front-end/client communication ports.
|-
|-
| &nbsp; || <tt>backend-ips</tt> || List of IP addresses used to identify which ports are to be used for Ceph Cluster inter-node back-end communication.  List can be the same as the client side network ports but better performance can be achieved by separating the front-end/client and back-end networks.
| &nbsp; || <tt>backend-ips</tt> || List of IP addresses used to identify which ports are to be used for Ceph Cluster inter-node back-end communication, if not specified the list specified for the front-end ports will be used.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
Line 647: Line 749:
|-
|-
| &nbsp; || <tt>enable-osd-encryption</tt> || Enables inline encryption for OSDs using AES 256 bit encryption for data-at-rest. (default: disabled)
| &nbsp; || <tt>enable-osd-encryption</tt> || Enables inline encryption for OSDs using AES 256 bit encryption for data-at-rest. (default: disabled)
|-
| &nbsp; || <tt>encryption-mode</tt> || Type of encryption, software (luks) or self-encryption (SED). [SED, *default, luks]
|-
|-
| &nbsp; || <tt>enable-osd-compression</tt> || Enables inline compression for OSDs using the 'snappy' algorithm. (default: disabled)
| &nbsp; || <tt>enable-osd-compression</tt> || Enables inline compression for OSDs using the 'snappy' algorithm. (default: disabled)
Line 654: Line 758:
| &nbsp; || <tt>osd-out-timeout-sec</tt> || Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
| &nbsp; || <tt>osd-out-timeout-sec</tt> || Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 666: Line 772:
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 678: Line 784:
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 691: Line 797:
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
===ceph-cluster-health-event-list===
Returns a list of all the active Ceph Cluster health check event.
<pre> qs ceph-cluster-health-event-list|cc-health-event-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 command. [min]
|}
===ceph-cluster-import===
Import an existing Ceph Cluster.
<pre> qs ceph-cluster-import|cc-import [--name=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 731: Line 863:
Modify a Ceph Cluster using the specified Storage System(s).
Modify a Ceph Cluster using the specified Storage System(s).


<pre> qs ceph-cluster-modify|cc-modify --ceph-cluster=value [--name=value ] [--desc=value ] [--flags=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--near-fill-full-percent=value ] [--back-fill-full-percent=value ] [--full-percent=value ] </pre>
<pre> qs ceph-cluster-modify|cc-modify --ceph-cluster=value [--name=value ] [--desc=value ] [--flags=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--near-fill-full-percent=value ] [--back-fill-full-percent=value ] [--full-percent=value ] [--key-server-profile=value ] [--config-options-list=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 740: Line 872:
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
|-
| &nbsp; || <tt>osd-down-timeout-sec</tt> || Amount of time until a given unresponsive OSD is switched to the 'down' state.  OSDs in the 'down' state will auto sync and recover when they come back online.
| &nbsp; || <tt>osd-down-timeout-sec</tt> || Amount of time until a given unresponsive OSD is switched to the 'down' state.  OSDs in the 'down' state will auto sync and recover when they come back online.
Line 751: Line 883:
|-
|-
| &nbsp; || <tt>full-percent</tt> || Cluster storage percentage at which cluster is full and clients are stopped from writing data.
| &nbsp; || <tt>full-percent</tt> || Cluster storage percentage at which cluster is full and clients are stopped from writing data.
|-
| &nbsp; || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
| &nbsp; || <tt>config-options-list</tt> || General Ceph Cluster configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
|}
|}


Line 764: Line 900:
| &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>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 771: Line 907:
Delete/archive a list of ceph cluster service events
Delete/archive a list of ceph cluster service events


<pre> qs ceph-cluster-service-event-delete|cc-srv-event-delete --ceph-cluster=value --service-event-id-list=value [--prune-events=value ] [--flags=value ] </pre>
<pre> qs ceph-cluster-service-event-delete|cc-srv-event-delete [--ceph-cluster=value ] [--prune-events=value ] [--service-event-id-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 778: Line 914:
| &nbsp; || <tt>prune-events</tt> || Prune specified service event. Default is to archive the event.
| &nbsp; || <tt>prune-events</tt> || Prune specified service event. Default is to archive the event.
|-
|-
| &nbsp; || <tt>service-event-id-list</tt> || Ceph cluster events.
| &nbsp; || <tt>service-event-id-list</tt> || Ceph Cluster service crash event ID list.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 785: Line 921:


===ceph-cluster-service-event-list===
===ceph-cluster-service-event-list===
Returns a list of ceph cluster service events
Returns a list of Ceph Cluster service crash events.


<pre> qs ceph-cluster-service-event-list|cc-srv-event-list --ceph-cluster=value [--include-old-events=value ] [--flags=value ] </pre>
<pre> qs ceph-cluster-service-event-list|cc-srv-event-list [--ceph-cluster=value ] [--include-old-events=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 826: Line 962:
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>rule-deviceclass</tt> || Ceph CRUSH rule device class {'hdd', 'ssd', 'nvme'}
| &nbsp; || <tt>rule-deviceclass</tt> || Ceph CRUSH rule device class ( hdd | ssd | nvme )
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>rule-failuredomain</tt> || Ceph CRUSH rule failure domain { 'osd', 'host', 'rack' } : Default: 'host'
| &nbsp; || <tt>rule-failuredomain</tt> || Ceph CRUSH rule failure domain ( *host | osd | rack )
|-
|-
| &nbsp; || <tt>rule-root</tt> || Ceph CRUSH rule, root { Default: 'default' }
| &nbsp; || <tt>rule-root</tt> || Ceph CRUSH rule, root ( *default )
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 874: Line 1,010:




===ceph-metadata-server-add===
===ceph-ec-profile-create===
Configure a new metadata server in the Ceph Cluster.
Create a custom ceph pool profile for object or block storage.


<pre> qs ceph-metadata-server-add|cmds-add --ceph-cluster=value --ceph-cluster-member=value [--flags=value ] </pre>
<pre> qs ceph-ec-profile-create|ecp-create --k=value --m=value [--name=value ] [--ceph-cluster=value ] [--desc=value ] [--profile-failure-domain=value ] [--profile-technique=value ] [--ec-plugin=value ] [--device-class=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>name</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>ceph-cluster-member</tt> || Ceph Cluster Member name or ID.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>profile-failure-domain</tt> || Failure domain for the Ceph Pool {Default: host}.
|-
| &nbsp; || <tt>profile-technique</tt> || Erasure coding technique for Ceph Pool. {Default: reed-solomon-van}
|-
| &nbsp; || <tt>ec-plugin</tt> || Plug-in used for erasure coded Ceph Pool {*jerasure, isa, lrc, shec}
|-
| &nbsp; || <tt>device-class</tt> || Device class to pin the pool to. {hdd, ssd, nvme}
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 888: Line 1,038:




===ceph-metadata-server-get===
===ceph-ec-profile-delete===
Gets information about a specific CephFS metadata server in the Ceph Cluster.
Deletes the specified ceph pool profile.


<pre> qs ceph-metadata-server-get|cmds-get --ceph-metadata-server=value [--flags=value ] </pre>
<pre> qs ceph-ec-profile-delete|ecp-delete --ec-pool-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-metadata-server</tt> || Ceph Metadata server name or ID.
| &nbsp; || <tt>ec-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]
|}
 
 
===ceph-ec-profile-get===
Gets information about a specific ceph pool profile.
 
<pre> qs ceph-ec-profile-get|ecp-get --ec-pool-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ec-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-ec-profile-list===
Returns a list of all the ceph pool profile(s) present in the cluster.
 
<pre> qs ceph-ec-profile-list|ecp-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]
|}
 
 
===ceph-metadata-server-add===
Configure a new metadata server in the Ceph Cluster.
 
<pre> qs ceph-metadata-server-add|cmds-add --ceph-cluster=value --ceph-cluster-member-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>ceph-cluster-member-list</tt> || List of Ceph Cluster Member name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===ceph-metadata-server-get===
Gets information about a specific CephFS metadata server in the Ceph Cluster.
 
<pre> qs ceph-metadata-server-get|cmds-get --ceph-metadata-server=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-metadata-server</tt> || Ceph Metadata server name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 1,021: Line 1,221:
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
===ceph-osd-key-replace===
Replaces encryption key for encrypted OSD.
<pre> qs ceph-osd-key-replace|osd-krep --ceph-cluster=value --osd-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 1,057: Line 1,271:
Creates multiple new ceph OSD on the specified Ceph Cluster
Creates multiple new ceph OSD on the specified Ceph Cluster


<pre> qs ceph-osd-multi-create|osd-multi-create --ceph-cluster=value [--physical-disk-list=value ] [--journal-ssd-list=value ] [--use-unused-journal-devices=value ] [--enable-mirror=value ] [--quick-format-disks=value ] [--allow-mixed-size-journal-media=value ] [--force-external-journal-device=value ] [--wal-size=value ] [--db-size=value ] [--osd-type=value ] [--flags=value ] </pre>
<pre> qs ceph-osd-multi-create|osd-multi-create [--ceph-cluster=value ] [--physical-disk-list=value ] [--journal-ssd-list=value ] [--use-unused-journal-devices=value ] [--enable-mirror=value ] [--quick-format-disks=value ] [--allow-mixed-size-journal-media=value ] [--force-external-journal-device=value ] [--enable-dynamic-weighting=value ] [--wal-size=value ] [--db-size=value ] [--osd-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>physical-disk-list</tt> || List of comma separated physical disk ID to be used for OSD data disks during OSD create.
| &nbsp; || <tt>physical-disk-list</tt> || List of comma separated physical disk ID to be used for OSD data disks during OSD create. Disk filter tags may also be used, see disk-list help for details.
|-
|-
| &nbsp; || <tt>journal-ssd-list</tt> || List of comma separated SSD disk ID to be used for OSD journal devices during OSD create.
| &nbsp; || <tt>journal-ssd-list</tt> || List of comma separated SSD disk ID to be used for OSD journal devices during OSD create.  Disk filter tags may also be used, see disk-list help for details.
|-
|-
| &nbsp; || <tt>use-unused-journal-devices</tt> || Use unused journal devices on Storage System for OSD create.
| &nbsp; || <tt>use-unused-journal-devices</tt> || Use unused journal devices on Storage System for OSD create.
Line 1,075: Line 1,289:
|-
|-
| &nbsp; || <tt>force-external-journal-device</tt> || When the physical disk(s) supplied for OSD create are SSD/NVME but still want a journal wal/db device.
| &nbsp; || <tt>force-external-journal-device</tt> || When the physical disk(s) supplied for OSD create are SSD/NVME but still want a journal wal/db device.
|-
| &nbsp; || <tt>enable-dynamic-weighting</tt> || Weights will be calculated based on size and applied to OSDs during creation if set to true. Weights will be auto initialized by ceph if set to false.
|-
|-
| &nbsp; || <tt>wal-size</tt> || Size of the Ceph Journal Device used as a Write Ahead Log (WAL).  
| &nbsp; || <tt>wal-size</tt> || Size of the Ceph Journal Device used as a Write Ahead Log (WAL).  
Line 1,086: Line 1,302:




===ceph-osd-service-update===
===ceph-osd-replace===
Start/Stop/Restart the specified ceph OSD service
Replaces prepared OSDs


<pre> qs ceph-osd-service-update|osd-serv-up --osd-list=value [--service-update-mode=value ] [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs ceph-osd-replace|osd-rep --disk=value --ceph-osd=value --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>osd-list</tt> || Lists all Ceph OSDs.
| &nbsp; || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
|-
| &nbsp; || <tt>service-update-mode</tt> || Ceph OSD service update mode [restart, *start, stop]
| &nbsp; || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===ceph-osd-replace-prep===
Prepares selected OSDs to be replaced
 
<pre> qs ceph-osd-replace-prep|osd-rep-prep --ceph-osd=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===ceph-osd-reweight===
Reweight the given set of ceph OSDs to the specified weight.
 
<pre> qs ceph-osd-reweight|osd-rw --osd-weight-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>osd-weight-list</tt> || List of comma separated OSD IDs and the requested associated capacity percentage, given in the form '5:10,13:5,12:0' etc
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===ceph-osd-service-update===
Start/Stop/Restart the specified Ceph OSD service
 
<pre> qs ceph-osd-service-update|osd-serv-up --osd-list=value [--service-update-mode=value ] [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
| &nbsp; || <tt>service-update-mode</tt> || Ceph OSD service update mode [restart, *start, stop]
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
Line 1,103: Line 1,363:


===ceph-pool-create===
===ceph-pool-create===
Creates a new low-level Ceph Pool using the specified OSDs.
Creates a new low-level Ceph Pool used as Ceph Block Pool.


<pre> qs ceph-pool-create|cpool-create --name=value --ceph-cluster=value [--osd-list=value ] [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--rule-name=value ] [--flags=value ] </pre>
<pre> qs ceph-pool-create|cpool-create --name=value --ceph-cluster=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--pool-type=value ] [--rule-name=value ] [--use-case=value ] [--cache-tier=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 1,111: Line 1,371:
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
Line 1,122: Line 1,380:
| &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>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|-
| &nbsp; || <tt>pool-type</tt> || Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5. Default is replicated.
| &nbsp; || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'.  Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
|-
| &nbsp; || <tt>rule-name</tt> || Ceph crush map rule set name. ('default', if not specified)
|-
| &nbsp; || <tt>use-case</tt> || Default use case is S3 object storage but Openstack based pools may also be created in addition. [*block, file, object]
|-
|-
| &nbsp; || <tt>rule-name</tt> || Ceph crush map rule set name. (default : 'default', if not specified)
| &nbsp; || <tt>cache-tier</tt> || Creates an additional SSD pool as a write-back cache tier layered over the underlying HDD/EC based pool.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 1,190: Line 1,456:




===ec-profile-create===
===load-balancer-get===
Create a custom ceph pool profile for object or block storage.
Gets information about a specific load balancer instance.


<pre> qs ec-profile-create|ecp-create --k=value --m=value [--name=value ] [--ceph-cluster=value ] [--desc=value ] [--profile-failure-domain=value ] [--profile-technique=value ] [--ec-plugin=value ] [--flags=value ] </pre>
<pre> qs load-balancer-get|lb-get --load-balancer=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
| &nbsp; || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|-
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>name</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>profile-failure-domain</tt> || Failure domain for the Ceph Pool {Default: host}.
|-
| &nbsp; || <tt>profile-technique</tt> || Erasure coding technique for Ceph Pool. {Default: reed-solomon-van}
|-
| &nbsp; || <tt>ec-plugin</tt> || Plug-in used for erasure coded Ceph Pool {*jerasure, isa, lrc, shec}
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===ec-profile-delete===
===load-balancer-list===
Deletes the specified ceph pool profile.
Returns a list of all the load balancers for the specified Ceph Cluster or all instances if no cluster is specified.


<pre> qs ec-profile-delete|ecp-delete --ec-pool-profile=value [--flags=value ] </pre>
<pre> qs load-balancer-list|lb-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===ec-profile-get===
Gets information about a specific ceph pool profile.
 
<pre> qs ec-profile-get|ecp-get --ec-pool-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ec-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]
|}
 
 
===ec-profile-list===
Returns a list of all the ceph pool profile(s) present in the cluster.
 
<pre> qs ec-profile-list|ecp-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 1,255: Line 1,483:
Configures/adds a new S3 Object Storage Gateway (Ceph RGW) on a system within a given Ceph Cluster.
Configures/adds a new S3 Object Storage Gateway (Ceph RGW) on a system within a given Ceph Cluster.


<pre> qs s3-gateway-add|rgw-add --ceph-cluster=value --ceph-cluster-member=value --gw-ipaddress=value [--gw-port=value ] [--service-engine=value ] [--service-mode=value ] [--tcp-no-delay=value ] [--certificate-pem-data=value ] [--redirect-gateway-port=value ] [--flags=value ] </pre>
<pre> qs s3-gateway-add|rgw-add --gw-ipaddress-list=value [--ceph-cluster=value ] [--gw-port=value ] [--service-engine=value ] [--service-mode=value ] [--tcp-no-delay=value ] [--certificate-pem-data=value ] [--redirect-gateway-port=value ] [--load-balancer=value ] [--mapping-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>gw-ipaddress-list</tt> || Command separated list of IP addresses for S3 Object Storage Gateway (Ceph RGW).
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>ceph-cluster-member</tt> || Ceph Cluster Member name or ID.
| &nbsp; || <tt>gw-port</tt> || Port used by S3 Object Storage Gateway. [*7480, 7481]
|-
| &nbsp; || <tt>gw-ipaddress</tt> || IP address used by S3 Object Storage Gateway (Ceph RGW).
|-
| &nbsp; || <tt>gw-port</tt> || Port used by S3 Object Storage Gateway (default:443).
|-
|-
| &nbsp; || <tt>service-engine</tt> || Service engine type for the RADOS Gateway [*beast, civetweb]
| &nbsp; || <tt>service-engine</tt> || Service engine type for the RADOS Gateway [*beast, civetweb]
Line 1,272: Line 1,498:
| &nbsp; || <tt>tcp-no-delay</tt> || This enables the TCP_NODELAY=1 option in beast mode to speed up object storage operations for low latency SSD and NVMe media.
| &nbsp; || <tt>tcp-no-delay</tt> || This enables the TCP_NODELAY=1 option in beast mode to speed up object storage operations for low latency SSD and NVMe media.
|-
|-
| &nbsp; || <tt>certificate-pem-data</tt> || PEM File path or PEM file data
| &nbsp; || <tt>certificate-pem-data</tt> || File path to PEM file with certificate and key block for RGW S3 gateway SSL access.
|-
|-
| &nbsp; || <tt>redirect-gateway-port</tt> || Redirect port 80 and 443 to the Gateway port 7480. Note that the Quantastor WUI will stop working on this port but may be accessed via HTTPS via alternate port 8080.
| &nbsp; || <tt>redirect-gateway-port</tt> || Redirect port 80 and 443 to the Gateway port 7480. Note that the Quantastor WUI will stop working on this port but may be accessed via HTTPS via alternate port 8080.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
| &nbsp; || <tt>mapping-mode</tt> || Configures what protocol the load balancer uses and how that maps to the back-end RGW/S3 Gateway. [auto, http-to-http, *https-to-http, https-to-https]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 1,316: Line 1,546:
| &nbsp; || <tt>rgw-options-list</tt> || Ceph Rados Gateway configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
| &nbsp; || <tt>rgw-options-list</tt> || Ceph Rados Gateway configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 1,342: Line 1,572:
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 1,354: Line 1,584:
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 1,366: Line 1,596:
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
| &nbsp; || <tt>ceph-gateway</tt> || S3 Object Storage Gateway (Ceph RGW).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===s3-quota-get===
Returns details about a specific S3 Quota.
 
<pre> qs s3-quota-get|s3q-get --bucket-quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>bucket-quota</tt> || ID of an S3 object storage user/bucket quota.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===s3-quota-list===
Returns a list of the S3 Quotas for the specified Ceph Cluster.
 
<pre> qs s3-quota-list|s3q-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 command. [min]
|}
|}


Line 1,424: Line 1,630:
</div>
</div>


==Ceph Journal Management [CEPHJOURNAL]==
==Ceph Client Resource Management [CEPH-CLIENT]==
Commands for management, monitoring, and configuration of Ceph Journal Groups and Ceph Journal Devices.
Commands for managing client connections to ceph resources.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===ceph-journal-get===
===ceph-client-conf-export===
Returns details of a specific Ceph Journal Device.
Exports a client ceph.conf file to default location '/etc/ceph/qs-ceph.conf', unless the 'output-file' arguemnt is provided.


<pre> qs ceph-journal-get|cj-get --ceph-journal-device=value [--flags=value ] </pre>
<pre> qs ceph-client-conf-export|ccc-export --ceph-cluster=value [--output-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>output-file</tt> || Name of file to which input is written
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===ceph-journal-group-create===
===ceph-client-keyring-create===
Creates a Ceph Journal Group out of the specified device(s). If two devices are specified, the Journal Group will create the group as a RAID1 mirrored group to ensure fault-tolerance in the event of a device failure.  All systems should use mirrored Journal Groups to ensure OSDs do not need to be rebuilt due to a journal group device failure.
Creates a ceph client registered to a set of ceph resources.


<pre> qs ceph-journal-group-create|cjg-create --primary-disk=value [--secondary-disk=value ] [--flags=value ] </pre>
<pre> qs ceph-client-keyring-create|cckr-create --name=value --client-key-type=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>primary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>client-key-type</tt> || An enum to identify the type of resource the client keyring is associeted with. [cephfs, *rbd]
|-
|-
| &nbsp; || <tt>secondary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
| &nbsp; || <tt>resource-list</tt> || A list of either RBD pools or CephFS shares to be associated with the client.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===ceph-journal-group-delete===
===ceph-client-keyring-delete===
Deletes a Ceph Journal Group and all underlying Ceph Journal Devices to free up the underlying media for reuse.
Deletes an existing ceph client.


<pre> qs ceph-journal-group-delete|cjg-delete --ceph-journal-group=value [--flags=value ] </pre>
<pre> qs ceph-client-keyring-delete|cckr-delete --ceph-client=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
| &nbsp; || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===ceph-journal-group-get===
===ceph-client-keyring-export===
Returns details of a specific Ceph Journal Group.
Exports keyring file to default location '/etc/ceph/ceph.client.<name>.keyring', unless the 'output-file' arguemnt is provided.


<pre> qs ceph-journal-group-get|cjg-get --ceph-journal-group=value [--flags=value ] </pre>
<pre> qs ceph-client-keyring-export|cckr-export --ceph-client=value [--output-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
| &nbsp; || <tt>ceph-client</tt> || Ceph client name or uuid
|-
| &nbsp; || <tt>output-file</tt> || Name of file to which input is written
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===ceph-journal-group-list===
===ceph-client-keyring-get===
Returns a list of all the Ceph Journal Groups.
Returns ceph client by name or UUID.


<pre> qs ceph-journal-group-list|cjg-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs ceph-client-keyring-get|cckr-get --ceph-client=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 1,491: Line 1,703:




===ceph-journal-list===
===ceph-client-keyring-list===
Returns a list of all the Ceph Journal Devices.
Lists all known ceph clients.


<pre> qs ceph-journal-list|cj-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs ceph-client-keyring-list|cckr-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 1,503: Line 1,715:




===ceph-journal-migrate===
===ceph-client-keyring-resource-assoc-enum===
Migrate an OSD's Journal Device.
Lists all known ceph cluster resource associations.


<pre> qs ceph-journal-migrate|cj-migrate --ceph-cluster=value --ceph-journal-device=value [--ceph-journal-group=value ] [--flags=value ] </pre>
<pre> qs ceph-client-keyring-resource-assoc-enum|cckr-assoc-enum [--ceph-client=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-client</tt> || Ceph client name or uuid
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===ceph-client-keyring-resource-assoc-get===
Get the keyring association, identified by composite key 'ceph-client' + 'resource'
 
<pre> qs ceph-client-keyring-resource-assoc-get|cckr-assoc-get --ceph-client=value --resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
| &nbsp; || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|-
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
| &nbsp; || <tt>resource</tt> || The unique id of a volume or volume group or share or host or host group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


Line 1,521: Line 1,743:
</div>
</div>


==CephFS Management [CEPHFS]==
==Ceph Journal Management [CEPHJOURNAL]==
Commands for scale-out NAS filesystem setup within a managed Ceph Cluster.
Commands for management, monitoring, and configuration of Ceph Journal Groups and Ceph Journal Devices.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===ceph-filesystem-create===
===ceph-journal-delete===
Creates a new Ceph Filesystem for the Ceph Cluster to enable scale-out Network Share provisioning and access.
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.


<pre> qs ceph-filesystem-create|cephfs-create --name=value --ceph-cluster=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--pool-type=value ] [--rule-name=value ] [--flags=value ] </pre>
<pre> qs ceph-journal-delete|cj-delete --ceph-journal-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
| &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>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>pool-type</tt> || Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5. Default is replicated.
|-
| &nbsp; || <tt>rule-name</tt> || Ceph crush map rule set name. (default : 'default', if not specified)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===ceph-filesystem-delete===
===ceph-journal-get===
Deletes the specified Ceph Filesystem, WARNING all associated files and Ceph Pools will be destroyed.
Returns details of a specific Ceph Journal Device.


<pre> qs ceph-filesystem-delete|cephfs-delete --ceph-filesystem=value [--flags=value ] </pre>
<pre> qs ceph-journal-get|cj-get --ceph-journal-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
| &nbsp; || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===ceph-filesystem-get===
===ceph-journal-group-create===
Returns information about a specific Ceph Filesystem instance.
Creates a Ceph Journal Group out of the specified device(s). If two devices are specified, the Journal Group will create the group as a RAID1 mirrored group to ensure fault-tolerance in the event of a device failure.  All systems should use mirrored Journal Groups to ensure OSDs do not need to be rebuilt due to a journal group device failure.


<pre> qs ceph-filesystem-get|cephfs-get --ceph-filesystem=value [--flags=value ] </pre>
<pre> qs ceph-journal-group-create|cjg-create --primary-disk=value [--secondary-disk=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
| &nbsp; || <tt>primary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
|-
| &nbsp; || <tt>secondary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===ceph-filesystem-list===
===ceph-journal-group-delete===
Returns a list of all the Ceph Filesystems.
Deletes a Ceph Journal Group and all underlying Ceph Journal Devices to free up the underlying media for reuse.


<pre> qs ceph-filesystem-list|cephfs-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs ceph-journal-group-delete|cjg-delete --ceph-journal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===ceph-filesystem-modify===
===ceph-journal-group-get===
Modifies the settings for the specified Ceph Filesystem.
Returns details of a specific Ceph Journal Group.


<pre> qs ceph-filesystem-modify|cephfs-modify --ceph-filesystem=value --desc=value [--flags=value ] </pre>
<pre> qs ceph-journal-group-get|cjg-get --ceph-journal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}


</div>
</div>


==Cloud Backup Schedule Management [CLOUD-BACKUP]==
===ceph-journal-group-list===
Cloud Backup schedules provide a mechanism for automatic backups of storage volumes into remote S3 object storage.
Returns a list of all the Ceph Journal Groups.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===cloud-backup-schedule-create===
<pre> qs ceph-journal-group-list|cjg-list [--ceph-cluster=value ] [--flags=value ] </pre>
Creates a new schedule to automate backups to a cloud backup container.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===ceph-journal-list===
Returns a list of all the Ceph Journal Devices.
 
<pre> qs ceph-journal-list|cj-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &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>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>max-backups</tt> || Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>flags</tt> || Optional flags for the operation. [async]
|}
|}




===cloud-backup-schedule-delete===
===ceph-journal-migrate===
Deletes the specified cloud backup schedule.
Migrate an OSD's Journal Device.


<pre> qs cloud-backup-schedule-delete|cbs-delete --backup-sched=value [--flags=value ] </pre>
<pre> qs ceph-journal-migrate|cj-migrate --ceph-cluster=value --ceph-journal-device=value [--ceph-journal-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
| &nbsp; || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
|}


</div>
</div>
==CephFS Management [CEPHFS]==
Commands for scale-out NAS filesystem setup within a managed Ceph Cluster.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===cloud-backup-schedule-disable===
===ceph-filesystem-create===
Disables a cloud backup schedule so that it does not trigger backups.
Creates a new Ceph Filesystem for the Ceph Cluster to enable scale-out Network Share provisioning and access.


<pre> qs cloud-backup-schedule-disable|cbs-disable --backup-sched=value [--flags=value ] </pre>
<pre> qs ceph-filesystem-create|cephfs-create --name=value --ceph-cluster=value --pool-type=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--rule-name=value ] [--active-mds-count=value ] [--standby-mds-count=value ] [--auto-config-nfs=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'.  Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
| &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>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
| &nbsp; || <tt>rule-name</tt> || Ceph crush map rule set name. ('default', if not specified)
|-
| &nbsp; || <tt>active-mds-count</tt> || Number of active MDS instances
|-
| &nbsp; || <tt>standby-mds-count</tt> || Number of standby MDS instances
|-
| &nbsp; || <tt>auto-config-nfs</tt> || Auto configure NFS services for scale-out storage.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===cloud-backup-schedule-enable===
===ceph-filesystem-delete===
Enables a cloud backup schedule that was previously disabled.
Deletes the specified Ceph Filesystem, WARNING all associated files and Ceph Pools will be destroyed.


<pre> qs cloud-backup-schedule-enable|cbs-enable --backup-sched=value [--flags=value ] </pre>
<pre> qs ceph-filesystem-delete|cephfs-delete --ceph-filesystem=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===cloud-backup-schedule-get===
===ceph-filesystem-get===
Gets detailed information about a specific cloud backup schedule.
Returns information about a specific Ceph Filesystem instance.


<pre> qs cloud-backup-schedule-get|cbs-get --backup-sched=value [--flags=value ] </pre>
<pre> qs ceph-filesystem-get|cephfs-get --ceph-filesystem=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===cloud-backup-schedule-list===
===ceph-filesystem-list===
Lists all the cloud backup schedules in the system.
Returns a list of all the Ceph Filesystems.


<pre> qs cloud-backup-schedule-list|cbs-list [--flags=value ] </pre>
<pre> qs ceph-filesystem-list|cephfs-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===cloud-backup-schedule-modify===
===ceph-filesystem-modify===
Modifies the settings for the specified cloud backup schedule.
Modifies the settings for the specified Ceph Filesystem.


<pre> 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 ] </pre>
<pre> qs ceph-filesystem-modify|cephfs-modify --ceph-filesystem=value [--desc=value ] [--flags=value ] [--active-mds-count=value ] [--standby-mds-count=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &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>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>max-backups</tt> || Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===cloud-backup-schedule-trigger===
Immediately triggers the specified cloud backup schedule to start a backup.
 
<pre> qs cloud-backup-schedule-trigger|cbs-trigger --backup-sched=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
| &nbsp; || <tt>active-mds-count</tt> || Number of active MDS instances
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>standby-mds-count</tt> || Number of standby MDS instances
|}
 
 
===cloud-backup-schedule-volume-add===
Adds Storage Volumes to an existing cloud backup schedule.
 
<pre> qs cloud-backup-schedule-volume-add|cbs-v-add --backup-sched=value [--volume-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
 
 
===cloud-backup-schedule-volume-remove===
Removes Storage Volumes from an existing cloud backup schedule.
 
<pre> qs cloud-backup-schedule-volume-remove|cbs-v-remove --backup-sched=value [--volume-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>backup-sched</tt> || A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


Line 1,806: Line 1,986:
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,813: Line 1,993:
Recovers a cloud backup container that was previously removed or used with a prior installation.
Recovers a cloud backup container that was previously removed or used with a prior installation.


<pre> qs cloud-container-add|clcn-add --provider-creds=value --storage-url=value --container-type=value [--encryption-key=value ] [--enable-nfs=value ] [--attach-to=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
<pre> qs cloud-container-add|clcn-add --provider-creds=value --location=value --bucket-name=value [--encryption-key=value ] [--enable-nfs=value ] [--attach-to=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
| &nbsp; || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|-
| &nbsp; || <tt>storage-url</tt> || The Amazon S3 or other storage URL used to identify a cloud backup container.
| &nbsp; || <tt>location</tt> || Cloud storage provider endpoint location.
|-
|-
| &nbsp; || <tt>container-type</tt> || Specifies the type of container to create of either one-to-one (rclone) or dedup (s3ql).  If deduplicate is specified then the data is compressed, encrypted, and deduplicated so it cannot be accessed directly as objects.  As the name implies, the one-to-one mode creates one object for each file providing a true NAS gateway to object storage. [dedup, *rclone]
| &nbsp; || <tt>bucket-name</tt> || The cloud container name used to identify a cloud backup container.
|-
|-
| &nbsp; || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the cloud container.
| &nbsp; || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
|-
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
| &nbsp; || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
Line 1,844: Line 2,024:
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,858: Line 2,038:
| &nbsp; || <tt>location-tag</tt> || Location tag of the endpoint such as sjc01, not always required.
| &nbsp; || <tt>location-tag</tt> || Location tag of the endpoint such as sjc01, not always required.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,865: Line 2,045:
Creates a cloud backup container into which cloud backups of Storage Volumes can be made.
Creates a cloud backup container into which cloud backups of Storage Volumes can be made.


<pre> qs cloud-container-create|clcn-create --name=value --provider-creds=value [--desc=value ] [--location=value ] [--attach-to=value ] [--enable-nfs=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
<pre> qs cloud-container-create|clcn-create --name=value --provider-creds=value --location=value [--desc=value ] [--attach-to=value ] [--enable-nfs=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 1,896: Line 2,076:
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
| &nbsp; || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,906: Line 2,086:
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|-
| &nbsp; || <tt>delete-cloud-bucket</tt> || Delete the bucket from the cloud.
| &nbsp; || <tt>delete-cloud-bucket</tt> || Delete the bucket from the cloud.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,920: Line 2,100:
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,932: Line 2,112:
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 1,944: Line 2,124:
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 1,966: Line 2,146:
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>container</tt> || 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.
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===cloud-container-rescan===
Clears stale/cached metadata so that the Cloud Container presents the most current file and directory information.
 
<pre> qs cloud-container-rescan|clcn-rescan --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 2,016: Line 2,208:
| &nbsp; || <tt>auth-file</tt> || Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
| &nbsp; || <tt>auth-file</tt> || Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 2,050: Line 2,242:
| &nbsp; || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
| &nbsp; || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 2,127: Line 2,319:
|}
|}


</div>
</div>


==Physical Disk Management [DISK]==
===cloud-provider-storage-class-add===
Physical Disks represent storage media (SATA, SAS, nVME, SSD, HW RAID LVs, etc) that appear to the system via HBAs and internal controllers.
Adds a mew storage class for a cloud provider
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===disk-copy===
<pre> qs cloud-provider-storage-class-add|clpsc-add --provider=value --storage-class-tag=value --storage-description=value [--flags=value ] </pre>
Copies data from a Physical Disk or Storage Volume to a new Physical Disk, Storage Volume, or Network Share file.
{| cellspacing='0' cellpadding='5'
 
<pre> qs disk-copy|disk-cp --source-id=value --target-id=value --source-type=value --target-type=value [--target-name=value ] [--blocksize-kb=value ] [--target-format=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>source-id</tt> || ID of the source Physical Disk or Storage Volume to be copied.
| &nbsp; || <tt>provider</tt> || Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure.  Additional S3 Compatible object storage Cloud Providers may be added for private cloud.
|-
| &nbsp; || <tt>target-id</tt> || ID of the target Physical Disk, Network Share, or Storage Volume's Pool where data will be copied to.
|-
|-
| &nbsp; || <tt>source-type</tt> || Type of media where data will be copied from (Physical Disk or Storage Volume). [*disk, volume]
| &nbsp; || <tt>storage-class-tag</tt> || Tag for the Cloud Provider Storage Class
|-
|-
| &nbsp; || <tt>target-type</tt> || Type of media where data will be copied to (Physical Disk, Storage Volume, or Network Share [*disk, share, volume]
| &nbsp; || <tt>storage-description</tt> || Description of the Cloud Provider Storage Class
|-
|-
| &nbsp; || <tt>target-name</tt> || Name of the target Storage Volume or file in the target Network Share.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
| &nbsp; || <tt>target-format</tt> || Image type of the data once copied (Defaults to raw). [qcow, *raw, vhd, vmdk]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===disk-format===
===cloud-provider-storage-class-get===
Removes all encryption settings, partitions, does a quick format of the device, and then optionally shreds the contents.
Returns information about the specified Cloud Provider Storage Class


<pre> qs disk-format|pd-format --disk-list=value [--shred-mode=value ] [--release-io-fence=value ] [--flags=value ] </pre>
<pre> qs cloud-provider-storage-class-get|clpsc-get --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|-
| &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 command. [force, min]
|-
| &nbsp; || <tt>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===disk-get===
===cloud-provider-storage-class-list===
Gets information about a specific physical disk.
Returns a list of Cloud Provider Storage Class


<pre> qs disk-get|pd-get --disk=value [--flags=value ] </pre>
<pre> qs cloud-provider-storage-class-list|clpsc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===disk-global-spare-add===
===cloud-provider-storage-class-remove===
Adds one or more dedicated hotspares to the global hotspare pool.
Removes the specified storage class


<pre> qs disk-global-spare-add|hsm-add --disk-list=value [--flags=value ] </pre>
<pre> qs cloud-provider-storage-class-remove|clpsc-remove --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>
==Container Management [CONTAINER]==
Commands for the management of Containers which are objects that describe the instances of docker containers and their various configurations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===disk-global-spare-marker-cleanup===
===service-config-create===
Cleans up invalid marker records for the dedicated hotspare physical disks in the global hot-spare pool.
Creates a new Service Config with the specified configuration options.


<pre> qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] </pre>
<pre> qs service-config-create|serv-conf-create --name=value --service-definition-tag=value [--service-config-options-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>service-definition-tag</tt> || The tag of the Service Definition desired for the Service. [resilio, vsftp]
|-
| &nbsp; || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-global-spare-marker-delete===
===service-config-delete===
Deletes the specified global hotspare marker object.
Deletes the specified Service Config.


<pre> qs disk-global-spare-marker-delete|hsm-del --name=value [--flags=value ] </pre>
<pre> qs service-config-delete|serv-conf-delete --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-global-spare-marker-get===
===service-config-get===
Returns information about the specified global hotspare marker object.
Returns the specified Service Config.


<pre> qs disk-global-spare-marker-get|hsm-get --name=value [--flags=value ] </pre>
<pre> qs service-config-get|serv-conf-get --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-global-spare-marker-list===
===service-config-list===
Enumerates marker records for the dedicated hotspare physical disks in the global hot-spare pool.
Returns a list of Service Configs.


<pre> qs disk-global-spare-marker-list|hsm-list [--flags=value ] </pre>
<pre> qs service-config-list|serv-conf-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-global-spare-remove===
===service-config-option-add===
Removes one or more dedicated hotspares from the global hotspare pool.
Adds key=value style options to the given Service Config.


<pre> qs disk-global-spare-remove|hsm-remove --disk-list=value [--flags=value ] </pre>
<pre> qs service-config-option-add|serv-conf-opt-add --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
| &nbsp; || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-identify===
===service-config-option-get===
Pulses the disk activity light so that the specified disk can be identified in the chassis.
Returns the specified Service Config Option.


<pre> qs disk-identify|pd-id --disk=value [--pattern=value ] [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
<pre> qs service-config-option-get|serv-conf-opt-get --service-config=value --key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
| &nbsp; || <tt>key</tt> || A Service Config Option key.
|-
|-
| &nbsp; || <tt>pattern</tt> || Pattern to flash the disk LED lights in, p = short pulse, P = long pulse, d = short delay, D = long delay, ex: pattern=pppD
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===service-config-option-remove===
Removes key=value style options from the given Service Config.
 
<pre> qs service-config-option-remove|serv-conf-opt-remove --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
| &nbsp; || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-list===
===service-config-option-set===
Enumerates all physical disks.
Modify key=value style options from the given Service Config.


<pre> qs disk-list|pd-list [--filter=value ] [--normalize=value ] [--flags=value ] </pre>
<pre> qs service-config-option-set|serv-conf-opt-set --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>filter</tt> || Filter may include disk names/IDs, Storage System names/IDs, storage pool names/IDs, and a [N] identifier to select unused disks where N is the number of unused disks to select, [nopaths] to indicate no paths of a mulitpath or encrypted device, [paths] to only show paths, [used] to indicate only disks that are in use, [unused] to indicate disks that are available, [eq:SIZE] such as [eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
|-
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
| &nbsp; || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===disk-multipath-config-add===
===service-config-options-list===
Adds physical disk multipath configuration entries.
Lists all key=value options associated with the given Service Config.


<pre> qs disk-multipath-config-add|dmpc-add --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs service-config-options-list|serv-conf-opt-list --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>service-config</tt> || ID or name of Service Config.
|-
|-
| &nbsp; || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===disk-multipath-config-list===
===service-def-get===
Enumerates physical disk multipath configuration entries.
Returns the specified Service Definition.


<pre> qs disk-multipath-config-list|dmpc-list [--storage-system=value ] [--flags=value ] </pre>
<pre> qs service-def-get|serv-def-get --id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>id</tt> || Unique identifier (GUID) for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,313: Line 2,507:




===disk-multipath-config-remove===
===service-def-list===
Removes physical disk multipath configuration entries.
Returns a list of all Service Definitions.


<pre> qs disk-multipath-config-remove|dmpc-remove --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs service-def-list|serv-def-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,327: Line 2,517:




===disk-multipath-config-scan===
===service-get===
Scans physical disks for multipath capability.
Returns the specified Service.


<pre> qs disk-multipath-config-scan|dmpc-scan [--storage-system=value ] [--flags=value ] </pre>
<pre> qs service-get|serv-get --service-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>service-id</tt> || The name or ID of a Service.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,339: Line 2,529:




===disk-performance-test===
===service-list===
Performs performance tests on physical disks.
Returns a list of all Services.


<pre> qs disk-performance-test|pd-perftest --disk-list=value [--perf-test-type=value ] [--block-size=value ] [--block-count=value ] [--flags=value ] </pre>
<pre> qs service-list|serv-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
</div>
</div>
 
==Physical Disk Management [DISK]==
Physical Disks represent storage media (SATA, SAS, nVME, SSD, HW RAID LVs, etc) that appear to the system via HBAs and internal controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===disk-copy===
Copies data from a Physical Disk or Storage Volume to a new Physical Disk, Storage Volume, or Network Share file.
 
<pre> qs disk-copy|disk-cp --source-id=value --target-id=value --source-type=value --target-type=value [--target-name=value ] [--blocksize-kb=value ] [--target-format=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>source-id</tt> || ID of the source Physical Disk or Storage Volume to be copied.
|-
| &nbsp; || <tt>target-id</tt> || ID of the target Physical Disk, Network Share, or Storage Volume's Pool where data will be copied to.
|-
| &nbsp; || <tt>source-type</tt> || Type of media where data will be copied from (Physical Disk or Storage Volume). [*disk, volume]
|-
| &nbsp; || <tt>target-type</tt> || Type of media where data will be copied to (Physical Disk, Storage Volume, or Network Share [*disk, share, volume]
|-
|-
| &nbsp; || <tt>perf-test-type</tt> || The type of performance test to be performed. [*read-sequential]
| &nbsp; || <tt>target-name</tt> || Name of the target Storage Volume or file in the target Network Share.
|-
|-
| &nbsp; || <tt>block-size</tt> || Volume block size in string format, such as 512, 1k, 2k, 4k, 8k, 16k, 32k, 64k, 128k, 256k, 512k, 1M, 2M, etc
| &nbsp; || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
|-
| &nbsp; || <tt>block-count</tt> || Number of blocks
| &nbsp; || <tt>target-format</tt> || Image type of the data once copied (Defaults to raw). [qcow, *raw, vhd, vmdk]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===disk-scan===
===disk-format===
Scans for any new physical disks that may have been hot-plugged into the Storage System.
Removes all encryption settings, partitions, does a quick format of the device, and then optionally shreds the contents.


<pre> qs disk-scan|pd-scan [--storage-system=value ] [--flags=value ] </pre>
<pre> qs disk-format|pd-format --disk-list=value [--shred-mode=value ] [--release-io-fence=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &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>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===disk-spare-list===
===disk-get===
Enumerates dedicated hotspare physical disks in the global hotspare pool.
Gets information about a specific physical disk.


<pre> qs disk-spare-list|pd-spare-list [--flags=value ] </pre>
<pre> qs disk-get|pd-get --disk=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===path-list===
===disk-global-spare-add===
Enumerates all physical disk paths for multi-path devices.
Adds one or more dedicated hotspares to the global hotspare pool.


<pre> qs path-list|pdp-list [--flags=value ] </pre>
<pre> qs disk-global-spare-add|hsm-add --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==External System Managementd [EXTERNALSYSTEM]==
===disk-global-spare-marker-cleanup===
Commands for managing and discovering External Systems.
Cleans up invalid marker records for the dedicated hotspare physical disks in the global hot-spare pool.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===external-system-controller-get===
<pre> qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] </pre>
Returns information on the desired External System Controller.
 
<pre> qs external-system-controller-get|ext-sys-cntrlr-get --external-system-controller=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system-controller</tt> || Name or ID of the requested External System Controller.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===external-system-controller-list===
===disk-global-spare-marker-delete===
Returns a list of the discovered External System Controllers for a specified External System.
Deletes the specified global hotspare marker object.


<pre> qs external-system-controller-list|ext-sys-cntrlr-list [--external-system=value ] [--flags=value ] </pre>
<pre> qs disk-global-spare-marker-delete|hsm-del --name=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===external-system-credentials-add===
===disk-global-spare-marker-get===
Adds the required credentials for discovering an External System.
Returns information about the specified global hotspare marker object.


<pre> qs external-system-credentials-add|ext-sys-creds-add --name=value --ext-system-username=value --ext-system-password=value --primary-ip=value --secondary-ip=value [--flags=value ] </pre>
<pre> qs disk-global-spare-marker-get|hsm-get --name=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>ext-system-username</tt> || The username for accessing the External System.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>ext-system-password</tt> || The password for accessing the External System.
|-
| &nbsp; || <tt>primary-ip</tt> || Primary IP used to discover External Systems
|-
| &nbsp; || <tt>secondary-ip</tt> || Secondary IP used to discover External Systems if the primary IP fails.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===external-system-credentials-get===
===disk-global-spare-marker-list===
Returns the credentials information about the specified External System.
Enumerates marker records for the dedicated hotspare physical disks in the global hot-spare pool.


<pre> qs external-system-credentials-get|ext-sys-creds-get --ext-system-credentials=value [--flags=value ] </pre>
<pre> qs disk-global-spare-marker-list|hsm-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===external-system-credentials-list===
===disk-global-spare-remove===
Returns a list of all the credentials for External System discovery.
Removes one or more dedicated hotspares from the global hotspare pool.


<pre> qs external-system-credentials-list|ext-sys-creds-list [--flags=value ] </pre>
<pre> qs disk-global-spare-remove|hsm-remove --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===external-system-credentials-remove===
===disk-identify===
Remove credentials for discovering a specified External System.
Pulses the disk activity light so that the specified disk can be identified in the chassis.


<pre> qs external-system-credentials-remove|ext-sys-creds-remove --name=value --ext-system-username=value --ext-system-password=value [--flags=value ] </pre>
<pre> qs disk-identify|pd-id --disk=value [--pattern=value ] [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
|-
| &nbsp; || <tt>ext-system-username</tt> || The username for accessing the External System.
| &nbsp; || <tt>pattern</tt> || Pattern to flash the disk LED lights in, p = short pulse, P = long pulse, d = short delay, D = long delay, ex: pattern=pppD
|-
|-
| &nbsp; || <tt>ext-system-password</tt> || The password for accessing the External System.
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===external-system-get===
===disk-list===
Returns information on a specified discovered External System.
Enumerates all physical disks.


<pre> qs external-system-get|ext-sys-get --external-system=value [--flags=value ] </pre>
<pre> qs disk-list|pd-list [--filter=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>filter</tt> || Filter may include disk names/IDs, Storage System names/IDs, storage pool names/IDs, and a [N] identifier to select unused disks where N is the number of unused disks to select, [nopaths] to indicate no paths of a mulitpath or encrypted device, [paths] to only show paths, [used] to indicate only disks that are in use, [unused] to indicate disks that are available, [eq:SIZE] such as [eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,492: Line 2,698:




===external-system-list===
===disk-multipath-config-add===
Returns a list of all the discovered External Systems.
Adds physical disk multipath configuration entries.


<pre> qs external-system-list|ext-sys-list [--flags=value ] </pre>
<pre> qs disk-multipath-config-add|dmpc-add --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,502: Line 2,712:




===external-system-media-get===
===disk-multipath-config-list===
Returns information on a specified discovered External System Media device.
Enumerates physical disk multipath configuration entries.


<pre> qs external-system-media-get|ext-sys-med-get --external-system-media=value [--external-system=value ] [--flags=value ] </pre>
<pre> qs disk-multipath-config-list|dmpc-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system-media</tt> || Name or ID of the requested External System Media device.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,516: Line 2,724:




===external-system-media-list===
===disk-multipath-config-remove===
Returns a list of the discovered Media devices for a specified External System or specified External System Port Group.
Removes physical disk multipath configuration entries.


<pre> qs external-system-media-list|ext-sys-med-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
<pre> qs disk-multipath-config-remove|dmpc-remove --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
| &nbsp; || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,530: Line 2,738:




===external-system-modify===
===disk-multipath-config-scan===
Modifies the properties of an External System such as an alternative name, description, and enclosure layout.
Scans physical disks for multipath capability.


<pre> qs external-system-modify|ext-sys-modify --external-system=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--flags=value ] </pre>
<pre> qs disk-multipath-config-scan|dmpc-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>alt-name</tt> || Alternate name for an External System.
|-
| &nbsp; || <tt>description</tt> || A description for the object.
|-
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,548: Line 2,750:




===external-system-port-get===
===disk-performance-test===
Returns information on a specified Port on a discovered External System.
Performs performance tests on physical disks.


<pre> qs external-system-port-get|ext-sys-port-get --external-system-port=value [--external-system=value ] [--flags=value ] </pre>
<pre> qs disk-performance-test|pd-perftest --disk-list=value [--perf-test-type=value ] [--block-size=value ] [--block-count=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>perf-test-type</tt> || The type of performance test to be performed. [*read-sequential]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>block-size</tt> || Volume block size in string format, such as 512, 1k, 2k, 4k, 8k, 16k, 32k, 64k, 128k, 256k, 512k, 1M, 2M, etc
|}
 
 
===external-system-port-group-get===
Returns information on the desired External System Port Group.
 
<pre> qs external-system-port-group-get|ext-sys-port-grp-get --external-system-port-group=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
| &nbsp; || <tt>block-count</tt> || Number of blocks
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===external-system-port-group-list===
===disk-scan===
Returns a list of discovered Port Groups from a specified External System.
Scans for any new physical disks that may have been hot-plugged into the Storage System.


<pre> qs external-system-port-group-list|ext-sys-port-grp-list [--external-system=value ] [--flags=value ] </pre>
<pre> qs disk-scan|pd-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 2,588: Line 2,780:




===external-system-port-list===
===disk-search===
Returns a list of discovered Ports on a specified External System or a specified External System Port Group.
Returns a subset of Physical Disk objects matching the given criteria.


<pre> qs external-system-port-list|ext-sys-port-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
<pre> qs disk-search|pd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Physical Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===external-system-port-modify===
===disk-sed-hard-reset===
Modifies the properties of an External System Port such as IP and subnet mask.
Performs a hard PSID reset on the specified self-encrypting disk.


<pre> qs external-system-port-modify|ext-sys-port-modify --external-system-port=value [--external-system=value ] [--ip-address=value ] [--subnet=value ] [--flags=value ] </pre>
<pre> qs disk-sed-hard-reset|pd-sed-reset --disk-list=value --psid-passphrase=value [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>psid-passphrase</tt> || Physical Secure ID/passphrase.
|-
|-
| &nbsp; || <tt>subnet</tt> || The subnet of an IP address (defaults to /16)
| &nbsp; || <tt>options</tt> || Special options - reserved.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===external-system-scan===
===disk-spare-list===
Scan for discoverable External Systems.
Enumerates dedicated hotspare physical disks in the global hotspare pool.


<pre> qs external-system-scan|ext-sys-scan [--ext-system-credentials=value ] [--storage-system=value ] [--flags=value ] </pre>
<pre> qs disk-spare-list|pd-spare-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>


===external-system-sw-adapter-config-add===
==External System Managementd [EXTERNALSYSTEM]==
Commands for managing and discovering External Systems.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===external-system-assign-media===
Creates a Software Adapter to assign the specified list of External System Media devices to a Storage System.
Creates a Software Adapter to assign the specified list of External System Media devices to a Storage System.


<pre> qs external-system-sw-adapter-config-add|ext-sys-sw-adapter-config-add --storage-system=value --external-system-media-list=value [--flags=value ] </pre>
<pre> qs external-system-assign-media|ext-sys-assign-media --storage-system=value --external-system-media-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>external-system-media-list</tt> || A comma separated list of External System Media IDs.
| &nbsp; || <tt>external-system-media-list</tt> || A comma separated list of External System Media IDs, or the name/ID of an External System or External System Credentials to add all Media from an External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Storage System Grid Management [GRID]==
===external-system-controller-get===
Commands for management and formation of Storage Grids which are comprised of one or more Storage Systems. Storage Grids simplify management and enables advanced features including HA, DR, and scale-out configurations.
Returns information on the desired External System Controller.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===grid-add===
<pre> qs external-system-controller-get|ext-sys-cntrlr-get --external-system-controller=value [--external-system=value ] [--flags=value ] </pre>
Adds the specified Storage System to the management grid.
 
<pre> qs grid-add|mg-add --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>node-ipaddress</tt> || IP address of a Storage System node.
| &nbsp; || <tt>external-system-controller</tt> || Name or ID of the requested External System Controller.
|-
|-
| &nbsp; || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>node-password</tt> || Admin user account password.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-assoc-get===
===external-system-controller-list===
Get general information about the associated Storage System management grid.
Returns a list of the discovered External System Controllers for a specified External System.


<pre> qs grid-assoc-get|mg-aget --storage-system=value [--grid=value ] [--flags=value ] </pre>
<pre> qs external-system-controller-list|ext-sys-cntrlr-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &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. [async, force, forget-missing, min, *none]
|}
|}




===grid-assoc-list===
===external-system-credentials-add===
Returns a list of the associated Storage System nodes in the grid.
Adds the required credentials for discovering an External System.


<pre> qs grid-assoc-list|mg-alist [--flags=value ] </pre>
<pre> qs external-system-credentials-add|ext-sys-creds-add --name=value --ext-system-username=value --ext-system-password=value --primary-ip=value --secondary-ip=value [--external-system-type=value ] [--storage-system=value ] [--site-cluster=value ] [--port=value ] [--insecure=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>ext-system-username</tt> || The username for accessing the External System.
|-
| &nbsp; || <tt>ext-system-password</tt> || The password for accessing the External System.
|-
| &nbsp; || <tt>primary-ip</tt> || Primary IP used to discover External Systems
|-
| &nbsp; || <tt>secondary-ip</tt> || Secondary IP used to discover External Systems if the primary IP fails.
|-
| &nbsp; || <tt>external-system-type</tt> || Type of External System [corvault, *openflex]
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>site-cluster</tt> || The name or ID of a site cluster.
|-
| &nbsp; || <tt>port</tt> || Port number to run External System discovery against.
|-
| &nbsp; || <tt>insecure</tt> || Use insecure http if specified to true, else use secure https by default.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-create===
===external-system-credentials-get===
Creates a new management grid.  A given Storage System can only be a member of one grid at a time.
Returns the credentials information about the specified External System.


<pre> qs grid-create|mg-create --name=value [--desc=value ] [--flags=value ] </pre>
<pre> qs external-system-credentials-get|ext-sys-creds-get --ext-system-credentials=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===grid-delete===
===external-system-credentials-list===
Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.
Returns a list of all the credentials for External System discovery.


<pre> qs grid-delete|mg-delete [--flags=value ] </pre>
<pre> qs external-system-credentials-list|ext-sys-creds-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-get===
===external-system-credentials-remove===
Get general information about the Storage System management grid.
Remove credentials for discovering a specified External System.


<pre> qs grid-get|mg-get [--flags=value ] </pre>
<pre> qs external-system-credentials-remove|ext-sys-creds-remove --name=value --ext-system-username=value --ext-system-password=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>ext-system-username</tt> || The username for accessing the External System.
|-
| &nbsp; || <tt>ext-system-password</tt> || The password for accessing the External System.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-get-hosts===
===external-system-get===
Returns the /etc/hosts configuration file configuration for grid nodes.
Returns information on a specified discovered External System.


<pre> qs grid-get-hosts|mg-get-hosts [--flags=value ] </pre>
<pre> qs external-system-get|ext-sys-get --external-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-merge===
===external-system-host-get===
Merges two storage grids into one.
Returns information on the specified discovered External System Host


<pre> qs grid-merge|mg-merge --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
<pre> qs external-system-host-get|ext-sys-host-get --external-system-host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>node-ipaddress</tt> || IP address of a Storage System node.
| &nbsp; || <tt>external-system-host</tt> || The name or ID of the requested External System Host.
|-
| &nbsp; || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
|-
| &nbsp; || <tt>node-password</tt> || Admin user account password.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-modify===
===external-system-host-list===
Modify the management grid properties.
Returns a list of discovered External System Hosts


<pre> qs grid-modify|mg-modify --name=value [--desc=value ] [--flags=value ] </pre>
<pre> qs external-system-host-list|ext-sys-host-list --external-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-remove===
===external-system-host-volume-assoc-list===
Removes the specified Storage System from the management grid.
Returns a list of the External System Host to Volume associations.


<pre> qs grid-remove|mg-remove --storage-system=value [--flags=value ] </pre>
<pre> qs external-system-host-volume-assoc-list|ext-sys-host-vol-assoc-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-send-supportlogs===
===external-system-list===
Collect support logs from Storage Systems specified (default, all systems in the grid) and send to OSNEXUS tech support.
Returns a list of all the discovered External Systems.


<pre> qs grid-send-supportlogs|mg-send-supportlogs [--sys-list=value ] [--flags=value ] </pre>
<pre> qs external-system-list|ext-sys-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===grid-set-hosts===
===external-system-media-get===
Configures the /etc/hosts configuration file on all systems to include Storage System names.
Returns information on a specified discovered External System Media device.


<pre> qs grid-set-hosts|mg-set-hosts --portid-list=value [--flags=value ] </pre>
<pre> qs external-system-media-get|ext-sys-med-get --external-system-media=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>portid-list</tt> || List of UUIDs for the ethernet ports to be used for grid wide /etc/hosts file configuration.
| &nbsp; || <tt>external-system-media</tt> || Name or ID of the requested External System Media device.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-set-master===
===external-system-media-list===
Sets the master node for a Storage System.
Returns a list of the discovered Media devices for a specified External System or specified External System Port Group.


<pre> qs grid-set-master|mg-set --storage-system=value [--flags=value ] </pre>
<pre> qs external-system-media-list|ext-sys-med-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===grid-split===
===external-system-modify===
Splits / sub-divides a storage grid into two grids.
Modifies the properties of an External System such as an alternative name, description, and enclosure layout.


<pre> qs grid-split|mg-split --name=value [--sys-list=value ] [--flags=value ] </pre>
<pre> qs external-system-modify|ext-sys-modify --external-system=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>alt-name</tt> || Alternate name for an External System.
|-
| &nbsp; || <tt>description</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===ha-group-activate===
===external-system-pool-get===
Activates/enables the specified Storage Pool High-Availability Group to failover can occur on a system outage.
Returns information on a specified Pool from a specified External System.


<pre> qs ha-group-activate|hag-activate --ha-group=value [--flags=value ] </pre>
<pre> qs external-system-pool-get|ext-sys-port-pool-get --external-system-pool=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-create===
===external-system-pool-list===
Creates a new Storage Pool High-Availability Group.
Returns a list of discovered Pools from a specified External System.


<pre> qs ha-group-create|hag-create --pool=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--flags=value ] </pre>
<pre> qs external-system-pool-list|ext-sys-pool-list [--external-system=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>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
|-
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
|-
| &nbsp; || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===ha-group-deactivate===
===external-system-port-get===
Deactivates the specified Storage Pool High-Availability Group so that failover policies are disabled.
Returns information on a specified Port on a discovered External System.


<pre> qs ha-group-deactivate|hag-deactivate --ha-group=value [--flags=value ] </pre>
<pre> qs external-system-port-get|ext-sys-port-get --external-system-port=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-delete===
===external-system-port-group-get===
Deletes the specified Storage Pool High-Availability Group.
Returns information on the desired External System Port Group.


<pre> qs ha-group-delete|hag-delete --ha-group=value [--flags=value ] </pre>
<pre> qs external-system-port-group-get|ext-sys-port-grp-get --external-system-port-group=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-failover===
===external-system-port-group-list===
Manually triggers a failover of the specified storage pool using the associated storage pool HA group policy.
Returns a list of discovered Port Groups from a specified External System.


<pre> qs ha-group-failover|hag-failover --ha-group=value --storage-system=value [--flags=value ] </pre>
<pre> qs external-system-port-group-list|ext-sys-port-grp-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-get===
===external-system-port-list===
Gets information about the specified storage pool HA group
Returns a list of discovered Ports on a specified External System or a specified External System Port Group.


<pre> qs ha-group-get|hag-get --ha-group=value [--flags=value ] </pre>
<pre> qs external-system-port-list|ext-sys-port-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-list===
===external-system-port-modify===
Returns a list of all the HA groups
Modifies the properties of an External System Port such as IP and subnet mask.


<pre> qs ha-group-list|hag-list [--flags=value ] </pre>
<pre> qs external-system-port-modify|ext-sys-port-modify --external-system-port=value [--external-system=value ] [--ip-address=value ] [--subnet=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
|-
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>subnet</tt> || The subnet of an IP address (defaults to /16)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-group-modify===
===external-system-profile-apply===
Modifies the settings for the specified high-availability Group.
Configures a previously discovered External System according to the given External System Profile.


<pre> qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--enable-tertiary-node=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--flags=value ] </pre>
<pre> qs external-system-profile-apply|ext-sys-prof-apply --external-system=value --external-system-profile=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>external-system-profile</tt> || Name or ID of a given External System Profile.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>volume-count</tt> || Number of External System Volumes to batch create.
|-
|-
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
| &nbsp; || <tt>max-volume-size</tt> || If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
|-
|-
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
| &nbsp; || <tt>volume-size</tt> || Size of batch created External System Volumes.
|-
|-
| &nbsp; || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
| &nbsp; || <tt>assign-to-hosts</tt> || External System Volumes will be assigned to the given list of Hosts after creation of volumes.
|-
|-
| &nbsp; || <tt>enable-tertiary-node</tt> || Enable an HA group to have a tertiary failover node.
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|-
| &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>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
|}
| &nbsp; || <tt>client-connectivity-check-policy</tt> || Client connectivity failover policy indicates policy on when to failover if the designated IPs are not responding 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]
===external-system-profile-get===
Returns the specified External System Profile.
 
<pre> qs external-system-profile-get|ext-sys-prof-get --external-system-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>fc-port-linkstate-policy</tt> || Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
| &nbsp; || <tt>external-system-profile</tt> || Name or ID of a given External System Profile.
|-
|-
| &nbsp; || <tt>export-timeout</tt> || Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively.  If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===ha-interface-create===
===external-system-profile-list===
Creates a new virtual network interface for the specified HA failover group.
Returns a list of the available External System Profiles.


<pre> 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 ] [--nvmeof-enable=value ] [--fqdn=value ] [--flags=value ] </pre>
<pre> qs external-system-profile-list|ext-sys-prof-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
|}
| &nbsp; || <tt>parent-port</tt> || 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.
 
 
===external-system-scan===
Scan for discoverable External Systems.
 
<pre> qs external-system-scan|ext-sys-scan [--ext-system-credentials=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===external-system-volume-create===
Batch creates External System Volumes on the given External System Pool.
 
<pre> qs external-system-volume-create|ext-sys-vol-create --external-system-pool=value --volume-name-prefix=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>interface-tag</tt> || Tags are a alpha-numeric tag which is appended onto a given HA virtual interface for easy identification.
| &nbsp; || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>volume-name-prefix</tt> || Prefix to use for new External System Volumes.
|-
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
| &nbsp; || <tt>volume-count</tt> || Number of External System Volumes to batch create.
|-
|-
| &nbsp; || <tt>mac-address</tt> || MAC Address
| &nbsp; || <tt>max-volume-size</tt> || If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
|-
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
| &nbsp; || <tt>volume-size</tt> || Size of batch created External System Volumes.
|-
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
| &nbsp; || <tt>assign-to-hosts</tt> || External System Volumes will be assigned to the given list of Hosts after creation of volumes.
|-
|-
| &nbsp; || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-interface-delete===
===external-system-volume-delete===
Deletes the specified virtual network interface resource from the HA group
Deletes a list of External System Volumes.


<pre> qs ha-interface-delete|hai-delete --ha-interface=value [--flags=value ] </pre>
<pre> qs external-system-volume-delete|ext-sys-vol-del --external-system-volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
| &nbsp; || <tt>external-system-volume-list</tt> || A comma separated list of External System Volume IDs, or the name/ID of an External System or External System Credentials to add all Volumes from an External System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ha-interface-get===
===external-system-volume-get===
Gets information about the specified storage pool HA virtual network interface
Returns information on a specified External System Volume.


<pre> qs ha-interface-get|hai-get --ha-interface=value [--flags=value ] </pre>
<pre> qs external-system-volume-get|ext-sys-vol-get --external-system-volume=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
| &nbsp; || <tt>external-system-volume</tt> || Name or ID of the requested External System Volume.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>external-system</tt> || Name or ID of the requested External System.
|}
 
 
===ha-interface-list===
Returns a list of all the HA interfaces on the specified group
 
<pre> qs ha-interface-list|hai-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===ping-check===
===external-system-volume-list===
Pings the specified list of IP addresses and returns the list of IPs that responded to the ping check.
Returns a list of the discovered Volume from the specified External System or from the specified External System Pool.


<pre> qs ping-check|ping --verify-client-ips=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs external-system-volume-list|ext-sys-vol-list [--external-system=value ] [--external-system-pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>external-system</tt> || Name or ID of the requested External System.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 3,048: Line 3,261:
</div>
</div>


==Host Management [HOST]==
==Fc Remote Port Management [FC-REMOTE-PORT]==
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.
{CATEGORY DESCRIPTION GOES HERE}
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===host-add===
===fc-remote-port-enum===
Modifies a host entry. The username/password fields are optional and are not yet leveraged by the Storage System. Later this may be used to provide additional levels of integration such as automatic host side configuration of your iSCSI initiator.
List all remote FC port WWNs visible to FC target ports in the Storage System.


<pre> qs host-add|h-add --hostname=value [--iqn=value ] [--ip-address=value ] [--desc=value ] [--username=value ] [--password=value ] [--host-type=value ] [--flags=value ] </pre>
<pre> qs fc-remote-port-enum|fcrp-enum --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===fc-remote-port-get===
Details of a specific FC remote port.
 
<pre> qs fc-remote-port-get|fcrp-get --remote-port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>remote-port</tt> || FC WWN of a remote server's initiator port.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
| &nbsp; || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>
==Storage System Grid Management [GRID]==
Commands for management and formation of Storage Grids which are comprised of one or more Storage Systems. Storage Grids simplify management and enables advanced features including HA, DR, and scale-out configurations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===host-get===
===grid-add===
Gets information about a specific host.
Adds the specified Storage System to the management grid.


<pre> qs host-get|h-get --host=value [--flags=value ] </pre>
<pre> qs grid-add|mg-add --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>node-ipaddress</tt> || IP address of a Storage System node.
|-
| &nbsp; || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
|-
| &nbsp; || <tt>node-password</tt> || Admin user account password.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===host-initiator-add===
===grid-assoc-get===
Adds an additional iSCSI host initiator IQN or FC WWPN to the specified host.
Get general information about the associated Storage System management grid.


<pre> qs host-initiator-add|hi-add --host=value --iqn=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>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
| &nbsp; || <tt>grid</tt> || Name or ID of the Storage System grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===host-initiator-get===
===grid-assoc-list===
Gets information about a specific host identified by its initiator IQN or FC WWPN.
Returns a list of the associated Storage System nodes in the grid.


<pre> qs host-initiator-get|hi-get --iqn=value [--flags=value ] </pre>
<pre> qs grid-assoc-list|mg-alist [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===host-initiator-list===
===grid-create===
Returns a list of all the initiators iSCSI IQNs and FC WWPNs of the specified host
Creates a new management grid.  A given Storage System can only be a member of one grid at a time.


<pre> qs host-initiator-list|hi-list --host=value [--flags=value ] </pre>
<pre> qs grid-create|mg-create --name=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===host-initiator-remove===
===grid-delete===
Removes a iSCSI IQN or FC WWPN host initiator entry from the specified Host.
Deletes the management grid.  After the grid is deleted each node in the grid operates independently again.


<pre> qs host-initiator-remove|hi-remove --host=value --iqn=value [--flags=value ] </pre>
<pre> qs grid-delete|mg-delete [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===host-list===
===grid-get===
Returns a list of all the Hosts that you have added to the Storage 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.
Get general information about the Storage System management grid.


<pre> qs host-list|h-list [--flags=value ] </pre>
<pre> qs grid-get|mg-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===host-modify===
===grid-merge===
Modifies a host entry which contains a list of WWPN or IQN for a given host.
Merges two storage grids into one.


<pre> qs host-modify|h-modify --host=value [--desc=value ] [--ip-address=value ] [--username=value ] [--password=value ] [--host-type=value ] [--hostname=value ] [--flags=value ] </pre>
<pre> qs grid-merge|mg-merge --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>node-ipaddress</tt> || IP address of a Storage System node.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>node-password</tt> || Admin user account password.
|-
|-
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===grid-modify===
Modify the management grid properties.
 
<pre> qs grid-modify|mg-modify --name=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===host-remove===
===grid-remove===
Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.
Removes the specified Storage System from the management grid.


<pre> qs host-remove|h-remove --host=value [--flags=value ] </pre>
<pre> qs grid-remove|mg-remove --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Host Group Management [HOST-GROUP]==
===grid-send-supportlogs===
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).
Collect support logs from Storage Systems specified (default, all systems in the grid) and send to OSNEXUS tech support.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===host-group-create===
<pre> qs grid-send-supportlogs|mg-send-supportlogs [--system-list=value ] [--disable-scrub=value ] [--disable-upload=value ] [--flags=value ] </pre>
Creates a new host group with the specified name.
 
<pre> qs host-group-create|hg-create --name=value --host-list=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|-
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
| &nbsp; || <tt>disable-scrub</tt> || Disables scrubbing of the logs before uploading.  By default logs are scrubbed before uploading for improved security and GDPR compliance.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>disable-upload</tt> || Disables uploading of the logs for systems deployed with no internet access.  In this mode the logs must be manually downloaded from the system using scp or other utility and then sent to support.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===host-group-delete===
===grid-set-master===
Removes the specified host group.
Sets the master node for a Storage System.


<pre> qs host-group-delete|hg-delete --host-group=value [--flags=value ] </pre>
<pre> qs grid-set-master|mg-set --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===host-group-get===
===grid-split===
Gets information about a specific host group.
Splits / sub-divides a storage grid into two grids.


<pre> qs host-group-get|hg-get --host-group=value [--flags=value ] </pre>
<pre> qs grid-split|mg-split --name=value [--system-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===host-group-host-add===
==Storage Pool HA Failover Management [HA-FAILOVER]==
Adds a host to the specified host group.
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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===ha-group-activate===
Activates/enables the specified Storage Pool High-Availability Group to failover can occur on a system outage.


<pre> qs host-group-host-add|hg-host-add --host-group=value --host-list=value [--flags=value ] </pre>
<pre> qs ha-group-activate|hag-activate --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===host-group-host-remove===
===ha-group-create===
Removes a host from the specified host group.
Creates a new Storage Pool High-Availability Group.


<pre> qs host-group-host-remove|hg-host-remove --host-group=value --host-list=value [--flags=value ] </pre>
<pre> qs ha-group-create|hag-create --pool=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>desc</tt> || A description for the object.
|}
 
 
===host-group-list===
Returns a list of all the host groups.
 
<pre> qs host-group-list|hg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
|}
|-
 
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
 
|-
===host-group-modify===
| &nbsp; || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
Modifies the properties of a host group such as its name and/or description.
|-
 
| &nbsp; || <tt>settle-time</tt> || Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
<pre> qs host-group-modify|hg-modify --host-group=value [--name=value ] [--desc=value ] [--flags=value ] </pre>
|-
{| cellspacing='0' cellpadding='5'
| &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 indicates policy on when to failover if the designated IPs are not responding 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]
|-
| &nbsp; || <tt>fc-port-linkstate-policy</tt> || Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
|-
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
| &nbsp; || <tt>export-timeout</tt> || Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively.  If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>enforce-smb-allowed</tt> || Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>enforce-nfs-allowed</tt> || Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Hardware RAID Management [HWRAID]==
===ha-group-deactivate===
Integrated hardware management modules monitor, discover, correlate and manage all the key aspects of internal SAS HBAs and RAID Controllers.
Deactivates the specified Storage Pool High-Availability Group so that failover policies are disabled.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===hw-alarm-clear-all===
<pre> qs ha-group-deactivate|hag-deactivate --ha-group=value [--flags=value ] </pre>
Clears all the Hardware Alarms/Events that have been recorded for the specified Hardware Controller.
 
<pre> qs hw-alarm-clear-all|hwa-clear-all --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-alarm-get===
===ha-group-delete===
Returns information about a specific Hardware Alarm.
Deletes the specified Storage Pool High-Availability Group.


<pre> qs hw-alarm-get|hwa-get --id=value [--flags=value ] </pre>
<pre> qs ha-group-delete|hag-delete --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>id</tt> || Unique identifier (GUID) for the object.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-alarm-list===
===ha-group-failover===
Returns a list of all the current Hardware Alarms/Event messages generated from Hardware Controllers.
Manually triggers a failover of the specified storage pool using the associated storage pool HA group policy.


<pre> qs hw-alarm-list|hwa-list [--controller=value ] [--flags=value ] </pre>
<pre> qs ha-group-failover|hag-failover --ha-group=value --storage-system=value --import-health-checks=value --export-health-checks=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>import-health-checks</tt> || Review failover health status events of the target Storage System.
|-
| &nbsp; || <tt>export-health-checks</tt> || Review failover health status events of the source Storage System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===hw-controller-change-security-key===
===ha-group-get===
Change the security key for encryption on SED/FDE-enabled drives on Hardware Controller.
Gets information about the specified storage pool HA group


<pre> qs hw-controller-change-security-key|hwc-change-security-key --controller=value --old-security-key=value --security-key=value [--flags=value ] </pre>
<pre> qs ha-group-get|hag-get --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|-
| &nbsp; || <tt>old-security-key</tt> || Prior security key on HW Controller card, for changing key, for encryption on FDE-enabled secure disk drives.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===hw-controller-create-security-key===
===ha-group-list===
Create the security key for encryption on SED/FDE-enabled drives on Hardware Controller.
Returns a list of all the HA groups


<pre> qs hw-controller-create-security-key|hwc-create-security-key --controller=value --security-key=value [--flags=value ] </pre>
<pre> qs ha-group-list|hag-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===hw-controller-get===
===ha-group-modify===
Returns information about a specific Hardware Controller.
Modifies the settings for the specified high-availability Group.


<pre> qs hw-controller-get|hwc-get --controller=value [--flags=value ] </pre>
<pre> qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--enable-tertiary-node=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
|-
| &nbsp; || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
|-
| &nbsp; || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
|-
| &nbsp; || <tt>enable-tertiary-node</tt> || Enable an HA group to have a tertiary failover node.
|-
| &nbsp; || <tt>settle-time</tt> || Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
|-
| &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 indicates policy on when to failover if the designated IPs are not responding 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]
|-
| &nbsp; || <tt>fc-port-linkstate-policy</tt> || Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
| &nbsp; || <tt>export-timeout</tt> || Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively.  If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
|-
| &nbsp; || <tt>enforce-smb-allowed</tt> || Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
| &nbsp; || <tt>enforce-nfs-allowed</tt> || Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===hw-controller-group-get===
===ha-interface-create===
Returns information about all the support Hardware Controller Group types.
Creates a new virtual network interface for the specified HA failover group.


<pre> qs hw-controller-group-get|hwcg-get --controller-group=value [--flags=value ] </pre>
<pre> qs ha-interface-create|hai-create --ha-group=value --parent-port=value --ip-address=value [--netmask=value ] [--interface-tag=value ] [--desc=value ] [--mac-address=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller-group</tt> || Name or ID of a hardware RAID controller group.
| &nbsp; || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>parent-port</tt> || 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.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>interface-tag</tt> || Tags are a alpha-numeric tag which is appended onto a given HA virtual interface for easy identification.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>mac-address</tt> || MAC Address
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
|-
| &nbsp; || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
|-
| &nbsp; || <tt>convert-vif</tt> || Convert existing local virtual ip address into an HA site VIF.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-controller-group-list===
===ha-interface-delete===
Returns a list of all the Hardware Controller Groups.
Deletes the specified virtual network interface resource from the HA group


<pre> qs hw-controller-group-list|hwcg-list [--flags=value ] </pre>
<pre> qs ha-interface-delete|hai-delete --ha-interface=value [--convert-to-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
|-
| &nbsp; || <tt>convert-to-vif</tt> || Convert HA site VIF resource into a local virtual ip address.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-controller-import-units===
===ha-interface-get===
Scan and import foreign disks associated with Hardware Controller Groups that were attached to another Hardware Controller or that require re-importing to the local appliance.
Gets information about the specified storage pool HA virtual network interface


<pre> qs hw-controller-import-units|hwc-import-units --controller=value [--flags=value ] </pre>
<pre> qs ha-interface-get|hai-get --ha-interface=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===hw-controller-list===
===ha-interface-list===
Returns a list of all the Hardware Controllers.
Returns a list of all the HA interfaces on the specified group


<pre> qs hw-controller-list|hwc-list [--controller-group=value ] [--flags=value ] </pre>
<pre> qs ha-interface-list|hai-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>controller-group</tt> || Name or ID of a hardware RAID controller group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 3,419: Line 3,684:




===hw-controller-rescan===
===network-check===
Rescans the Hardware Controller to look for new disks and RAID units.
Verified connectivity to all clients and Storage Systems associted with the specified system as well as any additional IP addresses specified.


<pre> qs hw-controller-rescan|hwc-rescan --controller=value [--flags=value ] </pre>
<pre> qs network-check|net-check [--storage-system=value ] [--verify-client-ips=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &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>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-controller-rescan-all===
===ping-check===
Rescans the system to rediscover all Hardware Controller and to look for new disks and RAID units on all controllers.
Pings the specified list of IP addresses and returns the list of IPs that responded to the ping check.


<pre> qs hw-controller-rescan-all|hwc-rescan-all [--storage-system=value ] [--flags=value ] </pre>
<pre> qs ping-check|ping --verify-client-ips=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &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>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>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===hw-disk-clear-missing===
==Health Checks [HEALTH-CHECKER]==
Clears all the hardware disk devices which are marked as missing and are no longer present.  This clears that information from the internal grid database.
Operations for various health checks.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===ha-group-check-health-status===
Runs a health check to evaluate failover ability of the given Storage Pool(s) and returns the results.


<pre> qs hw-disk-clear-missing|hwd-clear-missing [--controller=value ] [--storage-system=value ] [--flags=value ] </pre>
<pre> qs ha-group-check-health-status|hag-check-health-status --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===hw-disk-delete===
===ha-group-get-health-status===
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.
Returns the health status and failover ability of the given Storage Pool(s).


<pre> qs hw-disk-delete|hwd-delete --disk-list=value [--flags=value ] </pre>
<pre> qs ha-group-get-health-status|hag-get-health-status --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===hw-disk-get===
===host-add===
Returns information about a specific disk managed by a Hardware Controller.
Modifies a host entry. The username/password fields are optional and are not yet leveraged by the Storage System. Later this may be used to provide additional levels of integration such as automatic host side configuration of your iSCSI initiator.


<pre> qs hw-disk-get|hwd-get --disk=value [--flags=value ] </pre>
<pre> qs host-add|h-add --hostname=value [--iqn=value ] [--ip-address=value ] [--desc=value ] [--username=value ] [--password=value ] [--host-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk</tt> || Specifies a physical disk connected to a hardware RAID controller.
| &nbsp; || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>desc</tt> || A description for the object.
|}
 
 
===hw-disk-identify===
Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.
 
<pre> qs hw-disk-identify|hwd-identify --disk-list=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
| &nbsp; || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===hw-disk-list===
===host-get===
Returns a list of all the disks managed by the specified Hardware Controller.
Gets information about a specific host.


<pre> qs hw-disk-list|hwd-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
<pre> qs host-get|h-get --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===hw-disk-mark-good===
===host-initiator-add===
Marks the specified disk as 'good' or 'ready'.  You can use this to correct the disk status for good disks that the Hardware Controller has in 'bad' or 'failed' state.
Adds an additional iSCSI host initiator IQN or FC WWPN to the specified host.


<pre> qs hw-disk-mark-good|hwd-mark-good --disk-list=value [--flags=value ] </pre>
<pre> qs host-initiator-add|hi-add --host=value --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-disk-mark-spare===
===host-initiator-get===
Marks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.
Gets information about a specific host identified by its initiator IQN or FC WWPN.


<pre> qs hw-disk-mark-spare|hwd-mark-spare --disk-list=value [--flags=value ] </pre>
<pre> qs host-initiator-get|hi-get --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===hw-disk-unmark-spare===
===host-initiator-list===
Unmarks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.
Returns a list of all the initiators iSCSI IQNs and FC WWPNs of the specified host


<pre> qs hw-disk-unmark-spare|hwd-unmark-spare --disk-list=value [--flags=value ] </pre>
<pre> qs host-initiator-list|hi-list --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===hw-enclosure-get===
===host-initiator-remove===
Returns information about a specific enclosure managed by the specified Hardware Controller.
Removes a iSCSI IQN or FC WWPN host initiator entry from the specified Host.


<pre> qs hw-enclosure-get|hwe-get --enclosure=value [--flags=value ] </pre>
<pre> qs host-initiator-remove|hi-remove --host=value --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|}
 
 
===hw-enclosure-layout-get===
Returns information about a specific enclosure layout managed by the current system.
 
<pre> qs hw-enclosure-layout-get|hwe-layout-get --hw-enclosure-layout=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>hw-enclosure-layout</tt> || Name of the hardware RAID enclosure layout or its unique ID
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-enclosure-layout-list===
===host-list===
Returns a list of all the enclosure layouts managed by the current system.
Returns a list of all the Hosts that you have added to the Storage 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.


<pre> qs hw-enclosure-layout-list|hwe-layout-list [--flags=value ] </pre>
<pre> qs host-list|h-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===hw-enclosure-layout-vendor-group-get===
===host-modify===
Returns information about a specific enclosure layout vendor group managed by the current system.
Modifies a host entry which contains a list of WWPN or IQN for a given host.


<pre> qs hw-enclosure-layout-vendor-group-get|hwe-layout-vg-get --hw-enclosure-layout-vendor-group=value [--flags=value ] </pre>
<pre> qs host-modify|h-modify --host=value [--desc=value ] [--ip-address=value ] [--username=value ] [--password=value ] [--host-type=value ] [--hostname=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>hw-enclosure-layout-vendor-group</tt> || Name of the hardware RAID enclosure layout vendor group or its unique ID
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
| &nbsp; || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
|-
| &nbsp; || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===hw-enclosure-layout-vendor-group-list===
===host-remove===
Returns a list of all the enclosure layout vendor groups managed by the current system.
Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.


<pre> qs hw-enclosure-layout-vendor-group-list|hwe-layout-vg-list [--flags=value ] </pre>
<pre> qs host-remove|h-remove --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>
==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).
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===hw-enclosure-list===
===host-group-create===
Returns a list of all the enclosures managed by the specified Hardware Controller.
Creates a new host group with the specified name.


<pre> qs hw-enclosure-list|hwe-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
<pre> qs host-group-create|hg-create --name=value --host-list=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|-
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===hw-enclosure-modify===
===host-group-delete===
Modifies the properties of a specific enclosure managed by the specified Hardware Controller.
Removes the specified host group.


<pre> qs hw-enclosure-modify|hwe-modify --enclosure=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--chassis-tag=value ] [--flags=value ] </pre>
<pre> qs host-group-delete|hg-delete --host-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|-
| &nbsp; || <tt>alt-name</tt> || Alternate name for an enclosure within a hardware controller.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>chassis-tag</tt> || Name of a chassis tag for sorting hardware disks within hardware enclosures.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
|}




===hw-enclosure-slot-identify===
===host-group-get===
Flashes the LED indicator light on the specified slots in the RAID enclosure so that they can be identified in the enclosure.
Gets information about a specific host group.


<pre> qs hw-enclosure-slot-identify|hwe-slot-identify --enclosure=value --slot-list=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
<pre> qs host-group-get|hg-get --host-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|-
| &nbsp; || <tt>slot-list</tt> || List of the enclosure's slots to be identified/blinked.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===hw-unit-auto-create===
===host-group-host-add===
Creates new hardware RAID units automatically using available disk resources according to the selection criteria.
Adds a host to the specified host group.


<pre> qs hw-unit-auto-create|hwu-auto-create --raid-level=value [--disks-per-unit=value ] [--disk-category=value ] [--min-size=value ] [--max-size=value ] [--unit-count=value ] [--options=value ] [--storage-system=value ] [--controller=value ] [--flags=value ] </pre>
<pre> qs host-group-host-add|hg-host-add --host-group=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>raid-level</tt> || Hardware RAID type for a hardware RAID unit. [*RAID0, RAID1, RAID5, RAID6]
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|-
| &nbsp; || <tt>disks-per-unit</tt> || 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, RAID0 default = 1.
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
| &nbsp; || <tt>disk-category</tt> || 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]
|-
| &nbsp; || <tt>min-size</tt> || Minimum size of the disks to be selected for creation of new hardware RAID units
|-
| &nbsp; || <tt>max-size</tt> || 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.
|-
| &nbsp; || <tt>unit-count</tt> || Maximum number of units to create, if 0 then all available disks will be used after filtering.
|-
|-
| &nbsp; || <tt>options</tt> || Special options to hardware encryption policy.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===hw-unit-create===
===host-group-host-remove===
Creates a new hardware RAID unit using the specified controller.
Removes a host from the specified host group.


<pre> qs hw-unit-create|hwu-create --raid=value --disk-list=value [--controller=value ] [--flags=value ] </pre>
<pre> qs host-group-host-remove|hg-host-remove --host-group=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>raid</tt> || Hardware RAID type for a hardware RAID unit. [*AUTO, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60]
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===hw-unit-delete===
===host-group-list===
Deletes the specified RAID unit.  Note that you must first delete the Storage Pool before you delete the RAID unit.
Returns a list of all the host groups.


<pre> qs hw-unit-delete|hwu-delete --unit=value [--duration=value ] [--flags=value ] </pre>
<pre> qs host-group-list|hg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>unit</tt> || Name of a hardware RAID unit or it unique ID.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===hw-unit-encrypt===
===host-group-modify===
Enable hardware SED/FDE encryption for the specified hardware RAID unit.
Modifies the properties of a host group such as its name and/or description.


<pre> qs hw-unit-encrypt|hwu-encrypt --unit=value [--options=value ] [--flags=value ] </pre>
<pre> qs host-group-modify|hg-modify --host-group=value [--name=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>unit</tt> || Name of a hardware RAID unit or it unique ID.
| &nbsp; || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>options</tt> || Special options to hardware encryption policy.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
|}


</div>
</div>
==Hardware RAID Management [HWRAID]==
Integrated hardware management modules monitor, discover, correlate and manage all the key aspects of internal SAS HBAs and RAID Controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===hw-unit-get===
===hw-alarm-clear-all===
Returns information about a specific RAID unit managed by the specified Hardware Controller.
Clears all the Hardware Alarms/Events that have been recorded for the specified Hardware Controller.


<pre> qs hw-unit-get|hwu-get --unit=value [--flags=value ] </pre>
<pre> qs hw-alarm-clear-all|hwa-clear-all --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>unit</tt> || Name of a hardware RAID unit or it unique ID.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===hw-unit-identify===
===hw-alarm-get===
Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.
Returns information about a specific Hardware Alarm.


<pre> qs hw-unit-identify|hwu-identify --unit=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
<pre> qs hw-alarm-get|hwa-get --id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>unit</tt> || Name of a hardware RAID unit or it unique ID.
| &nbsp; || <tt>id</tt> || Unique identifier (GUID) for the object.
|-
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===hw-unit-list===
===hw-alarm-list===
Returns a list of all the RAID units managed by the specified Hardware Controller.
Returns a list of all the current Hardware Alarms/Event messages generated from Hardware Controllers.


<pre> qs hw-unit-list|hwu-list [--controller=value ] [--flags=value ] </pre>
<pre> qs hw-alarm-list|hwa-list [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 3,766: Line 4,027:
|}
|}


</div>
</div>


==License Management [LICENSE]==
===hw-controller-change-security-key===
Commands for management of Storage System license keys including adding, removing and listing License Keys.
Change the security key for encryption on SED/FDE-enabled drives on Hardware Controller.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===license-activate===
<pre> qs hw-controller-change-security-key|hwc-change-security-key --controller=value --old-security-key=value --security-key=value [--flags=value ] </pre>
Activates the system using a activation key received from customer support.
 
<pre> qs license-activate|lic-act --activation-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| 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>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>old-security-key</tt> || Prior security key on HW Controller card, for changing key, for encryption on FDE-enabled secure disk drives.
|}
|-
| &nbsp; || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}




===license-activate-online===
===hw-controller-create-security-key===
Requests automatic activation via the online activation service.
Create the security key for encryption on SED/FDE-enabled drives on Hardware Controller.


<pre> qs license-activate-online|lic-aon [--key=value ] [--renew-lease=value ] [--flags=value ] </pre>
<pre> qs hw-controller-create-security-key|hwc-create-security-key --controller=value --security-key=value [--flags=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>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>renew-lease</tt> || Does a lease renewal of the license, only applies to Cloud Edition keys which require lease renewal.
| &nbsp; || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===license-add===
===hw-controller-get===
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.
Returns information about a specific Hardware Controller.


<pre> qs license-add|lic-add --key-file=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs hw-controller-get|hwc-get --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>key-file</tt> || Key file you received which contains a key block section.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===license-get===
===hw-controller-group-get===
Shows the current license key info, and any activation request code.
Returns information about all the support Hardware Controller Group types.


<pre> qs license-get|lic-get [--key=value ] [--flags=value ] </pre>
<pre> qs hw-controller-group-get|hwcg-get --controller-group=value [--flags=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>controller-group</tt> || Name or ID of a hardware RAID controller group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 3,826: Line 4,082:




===license-list===
===hw-controller-group-list===
Returns a list of all the registered license keys.
Returns a list of all the Hardware Controller Groups.


<pre> qs license-list|lic-list [--flags=value ] </pre>
<pre> qs hw-controller-group-list|hwcg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 3,836: Line 4,092:




===license-modify-support===
===hw-controller-import-units===
Applies reseller and support contract information to the license key.  This information is also written to /var/opt/osnexus/quantastor/support.info for support log collection.
Scan and import foreign disks associated with Hardware Controller Groups that were attached to another Hardware Controller or that require re-importing to the local appliance.


<pre> qs license-modify-support|lic-modify-support --key=value [--reseller-name=value ] [--reseller-contact-number=value ] [--reseller-email=value ] [--support-contract-number=value ] [--flags=value ] </pre>
<pre> qs hw-controller-import-units|hwc-import-units --controller=value [--flags=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>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>reseller-name</tt> || Full name of the reseller technical support contact.
|-
|-
| &nbsp; || <tt>reseller-contact-number</tt> || Phone number of the reseller technical support contact.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>reseller-email</tt> || Email address of the reseller technical support contact.
|-
| &nbsp; || <tt>support-contract-number</tt> || Reseller support contract reference number.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===license-remove===
===hw-controller-list===
Removes the specified license key.
Returns a list of all the Hardware Controllers.


<pre> qs license-remove|lic-remove --key=value [--flags=value ] </pre>
<pre> qs hw-controller-list|hwc-list [--controller-group=value ] [--flags=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>controller-group</tt> || Name or ID of a hardware RAID controller group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>


==Maintenance Schedule Management [MAINTENANCE-SCHEDULE]==
===hw-controller-rescan===
Operations for scheduling of Storage Pool maintenance such as scrub and SSD TRIM operations.
Rescans the Hardware Controller to look for new disks and RAID units.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===maintenance-schedule-add===
<pre> qs hw-controller-rescan|hwc-rescan --controller=value [--flags=value ] </pre>
Adds Storage Pools to the specified Maintenance Schedule.
 
<pre> qs maintenance-schedule-add|maintenance-sch-add --maintenance-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===maintenance-schedule-assoc-get===
===hw-controller-rescan-all===
Returns details of a specific Maintenance Schedule association to a Storage Pool.
Rescans the system to rediscover all Hardware Controller and to look for new disks and RAID units on all controllers.


<pre> qs maintenance-schedule-assoc-get|maintenance-sch-assoc-get --maintenance-schedule=value --pool=value [--flags=value ] </pre>
<pre> qs hw-controller-rescan-all|hwc-rescan-all [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===maintenance-schedule-assoc-list===
===hw-controller-search===
Returns a list of all the Maintenance Schedule associations to Storage Pools
Returns a subset of HW Controller objects matching the given criteria.


<pre> qs maintenance-schedule-assoc-list|maintenance-sch-assoc-list --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-controller-search|hwc-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Hardware Controller List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
|}




===maintenance-schedule-create===
===hw-disk-clear-missing===
Creates a new Maintenance Schedule to periodically run bit-rot scrubs on Storage Pools to ensure data integrity.
Clears all the hardware disk devices which are marked as missing and are no longer present.  This clears that information from the internal grid database.


<pre> qs maintenance-schedule-create|maintenance-sch-create --name=value --description=value --enabled=value --start-date=value --min-days-between-scrubs=value --days=value --hours=value --offset-minutes=value --pool-list=value [--maintenance-type=value ] [--flags=value ] </pre>
<pre> qs hw-disk-clear-missing|hwd-clear-missing [--controller=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
| &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>min-days-between-scrubs</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots.
|-
| &nbsp; || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours.
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===maintenance-schedule-delete===
===hw-disk-delete===
Deletes the specified Maintenance Schedule.
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.


<pre> qs maintenance-schedule-delete|maintenance-sch-delete --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-disk-delete|hwd-delete --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===maintenance-schedule-disable===
===hw-disk-get===
Disables the specified Maintenance Schedule.
Returns information about a specific disk managed by a Hardware Controller.


<pre> qs maintenance-schedule-disable|maintenance-sch-disable --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-disk-get|hwd-get --disk=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>disk</tt> || Specifies a physical disk connected to a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===maintenance-schedule-enable===
===hw-disk-identify===
Enables the specified Maintenance Schedule.
Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.


<pre> qs maintenance-schedule-enable|maintenance-sch-enable --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-disk-identify|hwd-identify [--disk-list=value ] [--controller=value ] [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===maintenance-schedule-get===
===hw-disk-list===
Gets detailed properties of a specific Maintenance Schedule.
Returns a list of all the disks managed by the specified Hardware Controller.


<pre> qs maintenance-schedule-get|maintenance-sch-get --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-disk-list|hwd-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===maintenance-schedule-list===
===hw-disk-mark-good===
Returns a list of all the Maintenance Schedules.
Marks the specified disk as 'good' or 'ready'.  You can use this to correct the disk status for good disks that the Hardware Controller has in 'bad' or 'failed' state.


<pre> qs maintenance-schedule-list|maintenance-sch-list [--flags=value ] </pre>
<pre> qs hw-disk-mark-good|hwd-mark-good --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===maintenance-schedule-modify===
===hw-disk-mark-spare===
Used to modify the properties of a Maintenance Schedule including name and description.
Marks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.


<pre> qs maintenance-schedule-modify|maintenance-sch-modify --maintenance-schedule=value [--name=value ] [--description=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-scrubs=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--maintenance-type=value ] [--flags=value ] </pre>
<pre> qs hw-disk-mark-spare|hwd-mark-spare --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
|}
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
 
 
===hw-disk-search===
Returns a subset of HW Disk objects matching the given criteria.
 
<pre> qs hw-disk-search|hwd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>search-filter</tt> || Filter the results of the Hardware Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>min-days-between-scrubs</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
 
 
===hw-disk-unmark-spare===
Unmarks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.
 
<pre> qs hw-disk-unmark-spare|hwd-unmark-spare --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots.
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|-
| &nbsp; || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===hw-enclosure-get===
Returns information about a specific enclosure managed by the specified Hardware Controller.
 
<pre> qs hw-enclosure-get|hwe-get --enclosure=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===maintenance-schedule-remove===
===hw-enclosure-layout-get===
Removes Storage Pools from the specified Maintenance Schedule.
Returns information about a specific enclosure layout managed by the current system.


<pre> qs maintenance-schedule-remove|maintenance-sch-remove --maintenance-schedule=value --pool-list=value [--flags=value ] </pre>
<pre> qs hw-enclosure-layout-get|hwe-layout-get --hw-enclosure-layout=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
| &nbsp; || <tt>hw-enclosure-layout</tt> || Name of the hardware RAID enclosure layout or its unique ID
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===maintenance-schedule-trigger===
===hw-enclosure-layout-list===
Starts the specified Maintenance Schedule immediately.
Returns a list of all the enclosure layouts managed by the current system.


<pre> qs maintenance-schedule-trigger|maintenance-sch-trigger --maintenance-schedule=value [--flags=value ] </pre>
<pre> qs hw-enclosure-layout-list|hwe-layout-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>


==Cloud I/O Stats Management [METRICS]==
===hw-enclosure-layout-vendor-group-get===
Commands for the configuration and management of Librato Metrics cloud stats collection system.
Returns information about a specific enclosure layout vendor group managed by the current system.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===metrics-get===
<pre> qs hw-enclosure-layout-vendor-group-get|hwe-layout-vg-get --hw-enclosure-layout-vendor-group=value [--flags=value ] </pre>
Get the current username, token, and interval settings for Librato Metrics.
 
<pre> qs metrics-get|lm-get --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>hw-enclosure-layout-vendor-group</tt> || Name of the hardware RAID enclosure layout vendor group or its unique ID
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===metrics-set===
===hw-enclosure-layout-vendor-group-list===
Set the username, token, and interval for Librato Metrics posting.
Returns a list of all the enclosure layout vendor groups managed by the current system.


<pre> qs metrics-set|lm-set --username=value --token=value [--storage-system=value ] [--interval=value ] [--dashboards=value ] [--alert-anno=value ] [--config-anno=value ] [--flags=value ] </pre>
<pre> qs hw-enclosure-layout-vendor-group-list|hwe-layout-vg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===hw-enclosure-list===
Returns a list of all the enclosures managed by the specified Hardware Controller.
 
<pre> qs hw-enclosure-list|hwe-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>username</tt> || The username/email of the Librato Metrics account.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>token</tt> || The API token associated with the Librato Metrics account.
| &nbsp; || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|-
| &nbsp; || <tt>interval</tt> || The interval in seconds of how often a given Storage System should post data to Librato Metrics.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>dashboards</tt> || Automatically create the Storage 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.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


</div>
</div>


==Multi-Factor Authentication Configuration Management [MULTIFACTORAUTHCONFIG]==
===hw-enclosure-modify===
Multi-factor authentication configurations are required for enabling multi-factor authentication at login time for users.
Modifies the properties of a specific enclosure managed by the specified Hardware Controller.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===multi-factor-auth-config-create===
<pre> qs hw-enclosure-modify|hwe-modify --enclosure=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--chassis-tag=value ] [--flags=value ] </pre>
Creates a multi-factor authentication configuration including API host, integration key, and secrety key to enable multi-factor authentication.
 
<pre> qs multi-factor-auth-config-create|mfa-config-create --api-host=value --integration-key=value --secret-key=value --name=value [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>api-host</tt> || API host for DUO multi-factor authentication
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
|-
|-
| &nbsp; || <tt>integration-key</tt> || Integration key for DUO multi-factor authentication
| &nbsp; || <tt>alt-name</tt> || Alternate name for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>secret-key</tt> || secret-key
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>description</tt> || Description for the multi-factor authentication configuration.
| &nbsp; || <tt>chassis-tag</tt> || Name of a chassis tag for sorting hardware disks within hardware enclosures.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
|}




===multi-factor-auth-config-delete===
===hw-enclosure-search===
Deletes the multi-factor authentication configuration and removes it from all users which are currently using the specified configuration.
Returns a subset of HW Enclosure objects matching the given criteria.


<pre> qs multi-factor-auth-config-delete|mfa-config-delete --mfa-config-list=value [--flags=value ] </pre>
<pre> qs hw-enclosure-search|hwe-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>mfa-config-list</tt> || mfa-config-list
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Hardware Enclosure List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
|}




===multi-factor-auth-config-get===
===hw-enclosure-slot-identify===
Gets information about the specified multi-factor authentication configuration.
Flashes the LED indicator light on the specified slots in the RAID enclosure so that they can be identified in the enclosure.


<pre> qs multi-factor-auth-config-get|mfa-config-get --mfa-config=value [--flags=value ] </pre>
<pre> qs hw-enclosure-slot-identify|hwe-slot-identify --enclosure=value [--slot-list=value ] [--blink-type=value ] [--duration=value ] [--all-slots=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
| &nbsp; || <tt>enclosure</tt> || Name of a hardware RAID enclosure or it unique ID.
|-
| &nbsp; || <tt>slot-list</tt> || List of the enclosure's slots to be identified/blinked.
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|}
|-
 
| &nbsp; || <tt>all-slots</tt> || Perform action on all slots in the enclosure.
 
===multi-factor-auth-config-list===
Lists all multi-factor authentication configurations.
 
<pre> qs multi-factor-auth-config-list|mfa-config-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===multi-factor-auth-config-modify===
===hw-unit-auto-create===
Modifies the properties of the multi-factor authentication configuration such as its name and description.
Creates new hardware RAID units automatically using available disk resources according to the selection criteria.


<pre> qs multi-factor-auth-config-modify|mfa-config-modify --mfa-config=value [--secret-key=value ] [--name=value ] [--desc=value ] [--flags=value ] </pre>
<pre> qs hw-unit-auto-create|hwu-auto-create --raid-level=value [--disks-per-unit=value ] [--disk-category=value ] [--min-size=value ] [--max-size=value ] [--unit-count=value ] [--options=value ] [--storage-system=value ] [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
| &nbsp; || <tt>raid-level</tt> || Hardware RAID type for a hardware RAID unit. [*RAID0, RAID1, RAID5, RAID6]
|-
| &nbsp; || <tt>disks-per-unit</tt> || 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, RAID0 default = 1.
|-
| &nbsp; || <tt>disk-category</tt> || 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]
|-
| &nbsp; || <tt>min-size</tt> || Minimum size of the disks to be selected for creation of new hardware RAID units
|-
| &nbsp; || <tt>max-size</tt> || 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.
|-
| &nbsp; || <tt>unit-count</tt> || Maximum number of units to create, if 0 then all available disks will be used after filtering.
|-
|-
| &nbsp; || <tt>secret-key</tt> || Secret key for DUO multi-factor authentication
| &nbsp; || <tt>options</tt> || Special options to hardware encryption policy.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===multi-factor-auth-config-set-user===
===hw-unit-create===
Adds or removes multi-factor authentication configurations specified as 'user1=config1,user2=config2,~user3,...', prepend with tilde (~) to remove multi-factor authentication configurations from specified users.
Creates a new hardware RAID unit using the specified controller.


<pre> qs multi-factor-auth-config-set-user|mfa-config-set-user --user-config-assignments=value [--flags=value ] </pre>
<pre> qs hw-unit-create|hwu-create --raid=value --disk-list=value [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-config-assignments</tt> || User to multi-factor authentication configuration assignments specified as 'user1:config1,user2:config2,~user3,...' prepend with tilde (~) to remove configurations.
| &nbsp; || <tt>raid</tt> || Hardware RAID type for a hardware RAID unit. [*AUTO, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60]
|-
| &nbsp; || <tt>disk-list</tt> || Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Network Share Namespace Management [NAMESPACE]==
===hw-unit-delete===
Commands for managing Network Shares Namespaces which controls NFS redirects and Microsoft DFS for the SMB protocol.
Deletes the specified RAID unit.  Note that you must first delete the Storage Pool before you delete the RAID unit.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===share-namespace-add-shares===
<pre> qs hw-unit-delete|hwu-delete --unit=value [--duration=value ] [--flags=value ] </pre>
Adds one or more shares to the specified Network Share Namespace.
 
<pre> qs share-namespace-add-shares|nspc-add-shares --namespace=value --preferred-ports=value --share-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>unit</tt> || Name of a hardware RAID unit or it unique ID.
|-
|-
| &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>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===share-namespace-create===
===hw-unit-encrypt===
Creates a new Network Share Namespace which provides the ability to combine shares across appliances into a single namespace which integrates with Microsoft DFS.
Enable hardware SED/FDE encryption for the specified hardware RAID unit.


<pre> qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--dfs-mode=value ] [--nfs-mode=value ] [--flags=value ] </pre>
<pre> qs hw-unit-encrypt|hwu-encrypt --unit=value [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>unit</tt> || Name of a hardware RAID unit or it unique ID.
|-
|-
| &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>options</tt> || Special options to hardware encryption policy.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
|-
| &nbsp; || <tt>nfs-mode</tt> || nfs-mode [disabled, *flat]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===share-namespace-delete===
===hw-unit-get===
Deletes the specified Network Share Namespace, associated Network Shares are not deleted.
Returns information about a specific RAID unit managed by the specified Hardware Controller.


<pre> qs share-namespace-delete|nspc-delete --namespace=value [--flags=value ] </pre>
<pre> qs hw-unit-get|hwu-get --unit=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>unit</tt> || Name of a hardware RAID unit or it unique ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===share-namespace-get===
===hw-unit-identify===
Returns detailed information about the specified Network Share Namespace.
Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.


<pre> qs share-namespace-get|nspc-get --namespace=value [--flags=value ] </pre>
<pre> qs hw-unit-identify|hwu-identify --unit=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>unit</tt> || Name of a hardware RAID unit or it unique ID.
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===share-namespace-list===
===hw-unit-list===
Returns a list of all the Network Share Namespaces in the grid.
Returns a list of all the RAID units managed by the specified Hardware Controller.


<pre> qs share-namespace-list|nspc-list [--flags=value ] </pre>
<pre> qs hw-unit-list|hwu-list [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 4,272: Line 4,512:




===share-namespace-modify===
===hw-unit-search===
Modifies the selected Network Share Namespace properties including name, description, and features.
Returns a subset of HW Unit objects matching the given criteria.


<pre> qs share-namespace-modify|nspc-modify --namespace=value [--name=value ] [--desc=value ] [--dfs-mode=value ] [--nfs-mode=value ] [--flags=value ] </pre>
<pre> qs hw-unit-search|hwu-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>search-filter</tt> || Filter the results of the Hardware Unit List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|-
|}
| &nbsp; || <tt>desc</tt> || A description for the object.
 
|-
</div>
| &nbsp; || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
</div>
|-
| &nbsp; || <tt>nfs-mode</tt> || nfs-mode [disabled, *flat]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}


==Key Server Profile Management [KEY-SERVER-PROFILE]==
Key Server Profiles contain all of the neccessary certificate and connection information needed for KMIP operations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===share-namespace-remove-shares===
===key-server-profile-create===
Removes one or more shares from the specified Network Share Namespace.
Creates a key server profile.


<pre> qs share-namespace-remove-shares|nspc-remove-shares --namespace=value --preferred-ports=value --share-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-create|ksp-create --name=value --server-type=value --username=value --password=value --ca-cert=value --client-cert=value --client-key=value --host=value --kmip-connection-port=value --protocol=value --connection-mode=value --timeout=value [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>server-type</tt> || Specifies the type of KMIP compatable server is being used. [*default, ibm, kmip]
|-
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
| &nbsp; || <tt>ca-cert</tt> || The file location of the Certification Authority Certificate in x509 certificate format.
|-
| &nbsp; || <tt>client-cert</tt> || The file location of the Client Certificate in x509 certificate format.
|-
| &nbsp; || <tt>client-key</tt> || The file location of the Client Private Key in RSA private key format.
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
| &nbsp; || <tt>kmip-connection-port</tt> || The port number for which to estabilish a connection with the KIMP server host.
|-
| &nbsp; || <tt>protocol</tt> || Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
|-
|-
| &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>connection-mode</tt> || Connection mode for the server. [reconnect, *reset]
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &nbsp; || <tt>timeout</tt> || Timeout value for client-server KMIP operations (default: 10 sec).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>
==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 technology.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===pool-add-dedup-offload===
===key-server-profile-delete===
Adds a pair of mirrored dedicated deduplication metadata offload devices to the specified storage pool.
Deletes the specified key server profile.


<pre> qs pool-add-dedup-offload|p-add-dedup-offload --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-delete|ksp-delete --key-server-profile=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>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-add-metadata-offload===
===key-server-profile-get===
Adds a pair of mirrored dedicated metadata offload devices to the specified storage pool.
Returns the key information for the specified key.


<pre> qs pool-add-metadata-offload|p-add-metadata-offload --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-get|ksp-get --key-server-profile=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>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-add-read-cache===
===key-server-profile-key-add===
Adds a dedicated read cache to the specified storage pool.
Registers a key to the integrated key server.


<pre> qs pool-add-read-cache|p-add-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-key-add|ksp-key-add --key-server-profile=value --key-data=value --encoding=value --key-type=value --resource-type=value [--name=value ] [--description=value ] [--resource-id=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>key-server-profile</tt> || Identifier for Key Server Profile.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>key-data</tt> || Data payload for the key object being stored on the key server.
|}
|-
| &nbsp; || <tt>encoding</tt> || Data encoding for object stored on the key server. [*none]
|-
| &nbsp; || <tt>key-type</tt> || Key type sent in KMIP payload. [*all-key, data-encryption-key, root-key]
|-
| &nbsp; || <tt>resource-id</tt> || GUID for the resource the key is associated with. Required if '--resource-type' is 'storage-pool' or 'ceph-cluster'.
|-
| &nbsp; || <tt>resource-type</tt> || An enum to identify the type of resource the key is associated with. [none*,storage-pool,ceph-cluster] [ceph-cluster, *none, storage-pool]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}




===pool-add-spare===
===key-server-profile-key-modify===
Adds a dedicated hot-spare to the specified storage pool.
Modifies the name and description for a KMIP key.


<pre> qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-key-modify|ksp-key-modify [--key-server-profile=value ] [--name=value ] [--description=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>key-server-profile</tt> || Identifier for Key Server Profile.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-add-write-log===
===key-server-profile-key-remove===
Adds a dedicated write log to the specified storage pool.
Deletes the specified key from the key server.


<pre> qs pool-add-write-log|p-add-write-log --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs key-server-profile-key-remove|ksp-key-remove --key-server-profile=value --name=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>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-create===
===key-server-profile-list===
Creates a new storage pool from which Storage Volumes can be created.
Returns a list of all server profiles.


<pre> 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 ] [--auto-trim=value ] [--nobarriers=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--ashift=value ] [--flags=value ] </pre>
<pre> qs key-server-profile-list|ksp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters, special characters (-_.) excluding the parentheses. Size ranging from 2 to 40 characters.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===key-server-profile-modify===
Modifies the properties of a key server profile object.
 
<pre> qs key-server-profile-modify|ksp-modify --key-server-profile=value [--name=value ] [--description=value ] [--server-type=value ] [--username=value ] [--password=value ] [--ca-cert=value ] [--client-cert=value ] [--client-key=value ] [--host=value ] [--kmip-connection-port=value ] [--protocol=value ] [--connection-mode=value ] [--timeout=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>key-server-profile</tt> || Unique identifier (GUID) for the object.
|-
|-
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, and RAID5/50/6/60/7/70 are parity based fault-tolerant layouts. [*AUTO, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>pool-type</tt> || The type of storage pool to be created. [ceph-block, ceph-file, swap, xfs, *zfs]
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>server-type</tt> || Specifies the type of KMIP compatable server is being used. [*default, ibm, kmip]
|-
|-
| &nbsp; || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
| &nbsp; || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|-
| &nbsp; || <tt>ssd</tt> || Enable solid state disk (SSD) storage pool optimizations.
| &nbsp; || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|-
| &nbsp; || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
| &nbsp; || <tt>ca-cert</tt> || The file location of the Certification Authority Certificate in x509 certificate format.
|-
|-
| &nbsp; || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
| &nbsp; || <tt>client-cert</tt> || The file location of the Client Certificate in x509 certificate format.
|-
|-
| &nbsp; || <tt>nobarriers</tt> || Enable storage pool write optimizations.  This requires that you have a hardware controller with a battery backup unit.
| &nbsp; || <tt>client-key</tt> || The file location of the Client Private Key in RSA private key format.
|-
|-
| &nbsp; || <tt>profile</tt> || 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.
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>raid-set-size</tt> || Number of disks to use in each set of disks (aka VDEV) when creating a new storage pool with layout RAID10, RAIDZ1/50, RAIDZ2/60, or RAIDZ3.
| &nbsp; || <tt>kmip-connection-port</tt> || The port number for which to estabilish a connection with the KIMP server host.
|-
|-
| &nbsp; || <tt>encrypt</tt> || Enables encryption on all devices in the storage pool.  Encryption can only be enabled at the time of pool creation.
| &nbsp; || <tt>protocol</tt> || Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
|-
|-
| &nbsp; || <tt>encryption-type</tt> || Sets the encryption algorithm, currently only the default aes256 is supported. [aes256, *default]
| &nbsp; || <tt>connection-mode</tt> || Connection mode for the server. [reconnect, *reset]
|-
|-
| &nbsp; || <tt>passphrase</tt> || 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.
| &nbsp; || <tt>timeout</tt> || Timeout value for client-server KMIP operations (default: 10 sec).
|-
|-
| &nbsp; || <tt>ashift</tt> || Controls the block size offset for the devices which can impact usable capacity and performance. Recommend leaving this at 0 so that the system can automatically select based on the reported blocksize of the devices.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>
==Key Server Profile Key Management [KEY-SERVER-PROFILE-KEY]==
Key object  to key server profiles.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===pool-destroy===
===key-server-profile-key-get===
Deletes a storage pool, *WARNING* any data in the pool will be lost.
Gets the info of specified key that is on the given key server profile.


<pre> qs pool-destroy|p-destroy --pool=value [--shred-keys=value ] [--shred-mode=value ] [--flags=value ] </pre>
<pre> qs key-server-profile-key-get|ksp-key-get --key=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>key</tt> || Identifier for KMIP key.
|-
|-
| &nbsp; || <tt>shred-keys</tt> || Shreds the keys if the pool is an encrypted Storage Pool.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
|}
| &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]
|}




===pool-device-get===
===key-server-profile-key-list===
Gets information about a specific storage pool device.
Lists the key associations from the specified key server profile.


<pre> qs pool-device-get|spd-get --pool-device=value [--flags=value ] </pre>
<pre> qs key-server-profile-key-list|ksp-key-list [--key-server-profile=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>pool-device</tt> || Name or UUID of a storage pool device
| &nbsp; || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>
==License Management [LICENSE]==
Commands for management of Storage System license keys including adding, removing and listing License Keys.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===pool-device-group-get===
===license-activate===
Gets information about a specific storage pool device group.
Activates the system using a activation key received from customer support.


<pre> qs pool-device-group-get|spdg-get --pool-device-group=value [--flags=value ] </pre>
<pre> qs license-activate|lic-act --activation-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
| &nbsp; || <tt>activation-key</tt> || Activation key you'll receive from customer support after you send the activation request code.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===pool-device-group-identify===
===license-activate-online===
Pulses the disk activity lights for all disks in the pool device group so they can be identified in the chassis.
Requests automatic activation via the online activation service.


<pre> qs pool-device-group-identify|spdg-ident --pool-device-group=value [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
<pre> qs license-activate-online|lic-aon [--key=value ] [--renew-lease=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
| &nbsp; || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
| &nbsp; || <tt>renew-lease</tt> || Does a lease renewal of the license, only applies to Cloud Edition keys which require lease renewal.
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===pool-device-group-list===
===license-add===
Returns a list of all the storage pool device groups.
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 pool-device-group-list|spdg-list [--pool=value ] [--flags=value ] </pre>
<pre> qs license-add|lic-add --key-file=value [--storage-system=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>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>key-file</tt> || Key file you received which contains a key block section.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===pool-device-list===
===license-get===
Returns a list of all the storage pool devices.
Shows the current license key info, and any activation request code.


<pre> qs pool-device-list|spd-list [--pool=value ] [--flags=value ] </pre>
<pre> qs license-get|lic-get --key=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>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===pool-expand===
===license-list===
Expands a storage pool after the underlying hardware RAID unit has been grown underneath.
Returns a list of all the registered license keys.


<pre> qs pool-expand|p-expand --pool=value [--flags=value ] </pre>
<pre> qs license-list|lic-list [--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>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-export===
===license-modify-support===
Deactivate and removes the storage pool from the Storage System database so that it can be exported and used on another system.
Applies reseller and support contract information to the license key.  This information is also written to /var/opt/osnexus/quantastor/support.info for support log collection.


<pre> qs pool-export|p-export --pool=value [--release-io-fence=value ] [--metadata-only=value ] [--flags=value ] </pre>
<pre> qs license-modify-support|lic-modify-support --key=value [--reseller-name=value ] [--reseller-contact-number=value ] [--reseller-email=value ] [--support-contract-number=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>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
| &nbsp; || <tt>reseller-name</tt> || Full name of the reseller technical support contact.
|-
| &nbsp; || <tt>reseller-contact-number</tt> || Phone number of the reseller technical support contact.
|-
|-
| &nbsp; || <tt>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
| &nbsp; || <tt>reseller-email</tt> || Email address of the reseller technical support contact.
|-
|-
| &nbsp; || <tt>metadata-only</tt> || Export a new metadata archive to the '.poolmeta' directory for the specified pool. The pool is not exported, rather this option provides for a way to make a new explicit backup of pool metadata.
| &nbsp; || <tt>support-contract-number</tt> || Reseller support contract reference number.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===pool-get===
===license-remove===
Gets information about a specific storage pool.
Removes the specified license key.


<pre> qs pool-get|p-get --pool=value [--flags=value ] </pre>
<pre> qs license-remove|lic-remove --key=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>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==Maintenance Schedule Management [MAINTENANCE-SCHEDULE]==
Operations for scheduling of Storage Pool maintenance such as scrub and SSD TRIM operations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===pool-grow===
===maintenance-schedule-add===
Grows the specified storage pool by adding an additional disk.  You can only grow storage pools that are using the RAID5 or RAID6 layout.
Adds Storage Pools to the specified Maintenance Schedule.


<pre> qs pool-grow|p-grow --pool=value --disk-list=value [--raid-type=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-add|maintenance-sch-add --maintenance-schedule=value --pool-list=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>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, and RAID5/50/6/60/7/70 are parity based fault-tolerant layouts. [*AUTO, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-health-check===
===maintenance-schedule-assoc-get===
Checks the health/state of the pool and recursively checks the health of the associated disk devices to see if there are any issues anywhere in the stack.
Returns details of a specific Maintenance Schedule association to a Storage Pool.


<pre> qs pool-health-check|p-check --pool=value [--flags=value ] </pre>
<pre> qs maintenance-schedule-assoc-get|maintenance-sch-assoc-get --maintenance-schedule=value --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &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>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===pool-identify===
===maintenance-schedule-assoc-list===
Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.
Returns a list of all the Maintenance Schedule associations to Storage Pools


<pre> qs pool-identify|p-id --pool=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-assoc-list|maintenance-sch-assoc-list --maintenance-schedule=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>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-import===
===maintenance-schedule-create===
Imports the named storage pool(s) which have been previously exported.
Creates a new Maintenance Schedule to periodically run bit-rot scrubs on Storage Pools to ensure data integrity.


<pre> qs pool-import|p-import --storage-system=value --pool-list=value [--metadata-only=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-create|maintenance-sch-create --name=value [--maintenance-type=value ] [--description=value ] [--pool-list=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool.  Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|}
 
 
===pool-import-encrypted===
Imports the named encrypted storage pool(s) which have been previously exported, providing the given passphrase to decrypt the pool.
 
<pre> qs pool-import-encrypted|p-import-crypt --storage-system=value --pool-list=value [--passphrase=value ] [--metadata-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &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>pool-list</tt> || List of storage pools.
| &nbsp; || <tt>min-days-between-maint</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
|-
|-
| &nbsp; || <tt>passphrase</tt> || 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.
| &nbsp; || <tt>days</tt> || The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
|-
|-
| &nbsp; || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool.  Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
| &nbsp; || <tt>hours</tt> || Maintenance schedule must start on the specified hour. [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>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-key-export===
===maintenance-schedule-delete===
Exports all the encryption key information for the specified Storage Pool into a block that can be used in the future to re-import the keys.
Deletes the specified Maintenance Schedule.


<pre> qs pool-key-export|p-key-export --pool=value --key-file=value [--flags=value ] </pre>
<pre> qs maintenance-schedule-delete|maintenance-sch-delete --maintenance-schedule=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>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
| &nbsp; || <tt>key-file</tt> || File name to use for the exported pool key block.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 4,639: Line 4,914:




===pool-key-import===
===maintenance-schedule-disable===
Import the previously exported encryption keys for a Storage Pool to the specified Storage System.
Disables the specified Maintenance Schedule.


<pre> qs pool-key-import|p-key-import --key-file=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-disable|maintenance-sch-disable --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>key-file</tt> || File which contains the previously exported key block to use for importing.
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 4,653: Line 4,926:




===pool-list===
===maintenance-schedule-enable===
Returns a list of all the storage pools.
Enables the specified Maintenance Schedule.


<pre> qs pool-list|p-list [--vasa-support-only=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-enable|maintenance-sch-enable --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vasa-support-only</tt> || VASA support only.
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-modify===
===maintenance-schedule-get===
Modifies the properties of the storage pool such as its name and description.
Gets detailed properties of a specific Maintenance Schedule.


<pre> qs pool-modify|p-modify --pool=value [--name=value ] [--is-default=value ] [--ssd=value ] [--compress=value ] [--auto-trim=value ] [--nobarriers=value ] [--profile=value ] [--desc=value ] [--sync=value ] [--compression-type=value ] [--repair-policy=value ] [--approve-repair=value ] [--copies=value ] [--flags=value ] </pre>
<pre> qs maintenance-schedule-get|maintenance-sch-get --maintenance-schedule=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>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
 
 
===maintenance-schedule-list===
Returns a list of all the Maintenance Schedules.
 
<pre> qs maintenance-schedule-list|maintenance-sch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===maintenance-schedule-modify===
Used to modify the properties of a Maintenance Schedule including name and description.
 
<pre> qs maintenance-schedule-modify|maintenance-sch-modify --maintenance-schedule=value [--name=value ] [--description=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--maintenance-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ssd</tt> || Enable solid state disk (SSD) storage pool optimizations.
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>nobarriers</tt> || Enable storage pool write optimizations.  This requires that you have a hardware controller with a battery backup unit.
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>profile</tt> || 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.
| &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>desc</tt> || A description for the object.
| &nbsp; || <tt>min-days-between-maint</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
|-
|-
| &nbsp; || <tt>sync</tt> || 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]
| &nbsp; || <tt>days</tt> || The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
|-
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4)
| &nbsp; || <tt>hours</tt> || Maintenance schedule must start on the specified hour. [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>repair-policy</tt> || Type of automatic hotspare repair action to be applied. (assigned-and-global | assigned-only | assigned-and-global-exact | assigned-only-exact | manual-repair) [*assigned-and-global, assigned-and-global-exact, assigned-only, assigned-only-exact, manual]
| &nbsp; || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
|-
|-
| &nbsp; || <tt>approve-repair</tt> || 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
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>copies</tt> || 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).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-preimport-scan===
===maintenance-schedule-remove===
Returns a list of pools that are available to import but that are not yet discovered.
Removes Storage Pools from the specified Maintenance Schedule.


<pre> qs pool-preimport-scan|ppi-scan --storage-system=value [--flags=value ] </pre>
<pre> qs maintenance-schedule-remove|maintenance-sch-remove --maintenance-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 4,715: Line 5,002:




===pool-profile-get===
===maintenance-schedule-trigger===
Gets information about a specific storage pool profile.
Starts the specified Maintenance Schedule immediately.


<pre> qs pool-profile-get|pp-get --profile=value [--flags=value ] </pre>
<pre> qs maintenance-schedule-trigger|maintenance-sch-trigger --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>profile</tt> || 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.
| &nbsp; || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>
==Multi-Factor Authentication Configuration Management [MULTIFACTORAUTHCONFIG]==
Multi-factor authentication configurations are required for enabling multi-factor authentication at login time for users.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===pool-profile-list===
===multi-factor-auth-config-create===
Returns a list of all the storage pool profiles.
Creates a multi-factor authentication configuration including API host, integration key, and secrety key to enable multi-factor authentication.


<pre> qs pool-profile-list|pp-list [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-create|mfa-config-create --api-host=value --integration-key=value --secret-key=value --name=value [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>api-host</tt> || API host for DUO multi-factor authentication
|-
| &nbsp; || <tt>integration-key</tt> || Integration key for DUO multi-factor authentication
|-
| &nbsp; || <tt>secret-key</tt> || secret-key
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>description</tt> || Description for the multi-factor authentication configuration.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-remove-read-cache===
===multi-factor-auth-config-delete===
Removes the specified read cache from the specified pool.
Deletes the multi-factor authentication configuration and removes it from all users which are currently using the specified configuration.


<pre> qs pool-remove-read-cache|p-remove-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-delete|mfa-config-delete --mfa-config-list=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>mfa-config-list</tt> || mfa-config-list
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-remove-spare===
===multi-factor-auth-config-get===
Removes the specified hot-spare from the specified pool.
Gets information about the specified multi-factor authentication configuration.


<pre> qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-get|mfa-config-get --mfa-config=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>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-remove-write-log===
===multi-factor-auth-config-list===
Removes the specified write log from the specified pool.
Lists all multi-factor authentication configurations.


<pre> qs pool-remove-write-log|p-remove-write-log --pool=value --disk-list=value [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-list|mfa-config-list [--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>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-scan===
===multi-factor-auth-config-modify===
Rescans the specified Storage System for storage pools.
Modifies the properties of the multi-factor authentication configuration such as its name and description.


<pre> qs pool-scan|p-scan [--storage-system=value ] [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-modify|mfa-config-modify --mfa-config=value [--secret-key=value ] [--name=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
| &nbsp; || <tt>secret-key</tt> || Secret key for DUO multi-factor authentication
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===pool-scrub-start===
===multi-factor-auth-config-set-user===
Starts a scrub/verify operation on a ZFS-based Storage Pool (verifies data integrity and auto-corrects any bit-rot). See 'zpool scrub' command for additional control. For example, 'zpoolscrub --cron' will setup an automatic monthly scrub.
Adds or removes multi-factor authentication configurations specified as 'user1=config1,user2=config2,~user3,...', prepend with tilde (~) to remove multi-factor authentication configurations from specified users.


<pre> qs pool-scrub-start|p-scrub-start --pool=value [--flags=value ] </pre>
<pre> qs multi-factor-auth-config-set-user|mfa-config-set-user --user-config-assignments=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>user-config-assignments</tt> || User to multi-factor authentication configuration assignments specified as 'user1:config1,user2:config2,~user3,...' prepend with tilde (~) to remove configurations.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}


</div>
</div>
==Network Share Namespace Management [NAMESPACE]==
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'>


===pool-scrub-stop===
===share-namespace-add-shares===
Stops the an active scrub/verify operation on a ZFS-based Storage Pool.
Adds one or more shares to the specified Network Share Namespace.


<pre> qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] </pre>
<pre> qs share-namespace-add-shares|nspc-add-shares --namespace=value --share-list=value --preferred-ports=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>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>share-list</tt> || A list of one or more Network Shares.
|-
| &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>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===pool-set-passphrase===
===share-namespace-create===
Sets or clears the encryption passphrase for an encrypted storage pool.
Creates a new Network Share Namespace which provides the ability to combine shares across appliances into a single namespace which integrates with Microsoft DFS.


<pre> qs pool-set-passphrase|p-set-passphrase --pool=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ] </pre>
<pre> qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--dfs-mode=value ] [--nfs-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>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>current-passphrase</tt> || Current encryption passphrase for 'pool'. If issuing user has the 'Administrator' role and the pool is already started or if the pool is not currently passphrase protected this value can be omitted.
| &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>new-passphrase</tt> || New encryption passphrase for 'pool'. Omitting this argument will clear the encryption passphrase.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
|-
| &nbsp; || <tt>nfs-mode</tt> || nfs-mode [disabled, *flat]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===pool-start===
===share-namespace-delete===
Starts up a previously stopped storage pool.
Deletes the specified Network Share Namespace, associated Network Shares are not deleted.


<pre> qs pool-start|p-start --pool=value [--passphrase=value ] [--flags=value ] </pre>
<pre> qs share-namespace-delete|nspc-delete --namespace=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>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>passphrase</tt> || 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.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===pool-stop===
===share-namespace-get===
Stops all volume activity to the pool and disables it for maintenance.
Returns detailed information about the specified Network Share Namespace.


<pre> qs pool-stop|p-stop --pool=value [--flags=value ] </pre>
<pre> qs share-namespace-get|nspc-get --namespace=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>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>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===pool-trim===
===share-namespace-list===
Starts a trim operation on a ZFS-based Storage Pool. See 'zpool trim' command for additional control.
Returns a list of all the Network Share Namespaces in the grid.


<pre> qs pool-trim|p-trim --pool=value [--flags=value ] </pre>
<pre> qs share-namespace-list|nspc-list [--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>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>


==QoS Policy Management [QOSPOLICY]==
===share-namespace-modify===
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.
Modifies the selected Network Share Namespace properties including name, description, and features.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===qos-policy-create===
<pre> qs share-namespace-modify|nspc-modify --namespace=value [--name=value ] [--desc=value ] [--dfs-mode=value ] [--nfs-mode=value ] [--flags=value ] </pre>
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>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &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>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>bw-read</tt> || 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.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>bw-write</tt> || 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.
| &nbsp; || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>nfs-mode</tt> || nfs-mode [disabled, *flat]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 4,894: Line 5,204:




===qos-policy-delete===
===share-namespace-remove-shares===
Deletes a given QoS Policy and clears the QoS performance limits on all Storage Volumes associated with the policy.
Removes one or more shares from the specified Network Share Namespace.


<pre> qs qos-policy-delete|qos-delete --qos-policy=value [--flags=value ] </pre>
<pre> qs share-namespace-remove-shares|nspc-remove-shares --namespace=value [--share-list=value ] [--preferred-ports=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>qos-policy</tt> || 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.
| &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>share-list</tt> || A list of one or more Network Shares.
|-
| &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>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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 technology.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===qos-policy-get===
===pool-add-dedup-offload===
Returns detailed information about a specific QoS policy.
Adds a pair of mirrored dedicated deduplication metadata offload devices to the specified storage pool.


<pre> qs qos-policy-get|qos-get --qos-policy=value [--flags=value ] </pre>
<pre> qs pool-add-dedup-offload|p-add-dedup-offload --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>qos-policy</tt> || 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.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===qos-policy-list===
===pool-add-metadata-offload===
Returns details on the list of all QoS policy objects in the Storage System grid.
Adds a pair of mirrored dedicated metadata offload devices to the specified storage pool.


<pre> qs qos-policy-list|qos-list [--flags=value ] </pre>
<pre> qs pool-add-metadata-offload|p-add-metadata-offload --pool=value --disk-list=value [--small-block-threshold=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev.  Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===qos-policy-modify===
===pool-add-read-cache===
Modifies an existing QoS policy with a new name, description, or performance limits. Changes are applied immediately to all volumes.
Adds a dedicated read cache to the specified storage pool.


<pre> qs qos-policy-modify|qos-modify --qos-policy=value [--name=value ] [--desc=value ] [--bw-read=value ] [--bw-write=value ] [--flags=value ] </pre>
<pre> qs pool-add-read-cache|p-add-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>qos-policy</tt> || 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.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>bw-read</tt> || 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.
|-
| &nbsp; || <tt>bw-write</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>


==Resource Group Quota Management [QUOTA]==
===pool-add-spare===
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
Adds a dedicated hot-spare to the specified storage pool.
<div class='mw-collapsible'>
 
<div class='mw-collapsible-content'>
<pre> qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] </pre>
 
===provisioning-quota-create===
Creates a new storage provisioning quota on a pool for the specified tenant resource cloud.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &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>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
|-
| &nbsp; || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
|-
| &nbsp; || <tt>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
|-
| &nbsp; || <tt>max-shares</tt> || The maximum number of share that can be created using this quota, specify 0 for no limit.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 4,983: Line 5,285:




===provisioning-quota-delete===
===pool-add-write-log===
Deletes a storage provisioning quota, the associated volumes are not deleted.
Adds a dedicated write log to the specified storage pool.


<pre> qs provisioning-quota-delete|pq-delete --quota=value [--flags=value ] </pre>
<pre> qs pool-add-write-log|p-add-write-log --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|}
 
 
===provisioning-quota-get===
Returns information about a specific storage provisioning quota.
 
<pre> qs provisioning-quota-get|pq-get --quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===provisioning-quota-list===
===pool-create===
Returns a list of all the storage provisioning quotas.
Creates a new storage pool from which Storage Volumes can be created.


<pre> qs provisioning-quota-list|pq-list [--flags=value ] </pre>
<pre> qs pool-create|p-create --name=value --disk-list=value [--raid-type=value ] [--pool-type=value ] [--desc=value ] [--is-default=value ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--key-server-type=value ] [--key-server-profile=value ] [--ashift=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters, special characters (-_.) excluding the parentheses. Size ranging from 2 to 40 characters.
|}
 
 
===provisioning-quota-modify===
Modifies one to change the name and/or description of a storage provisioning quota.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>pool-type</tt> || The type of storage pool to be created. [swap, *zfs]
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
| &nbsp; || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
|-
|-
| &nbsp; || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
| &nbsp; || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
|-
| &nbsp; || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
|-
| &nbsp; || <tt>profile</tt> || 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.
|-
| &nbsp; || <tt>raid-set-size</tt> || Number of disks to use in each set of disks (aka VDEV) when creating a new storage pool with layout RAID10, RAIDZ1/50, RAIDZ2/60, or RAIDZ3.
|-
| &nbsp; || <tt>encrypt</tt> || Enables encryption on all devices in the storage pool or other storage resource.  Encryption can only be enabled at the time of storage resource creation.
|-
| &nbsp; || <tt>encryption-type</tt> || Sets the encryption algorithm, currently only the default aes256 is supported. [SED, aes256, *default]
|-
| &nbsp; || <tt>passphrase</tt> || 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.
|-
|-
| &nbsp; || <tt>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
| &nbsp; || <tt>key-server-type</tt> || Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
|-
|-
| &nbsp; || <tt>max-shares</tt> || The maximum number of share that can be created using this quota, specify 0 for no limit.
| &nbsp; || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
| &nbsp; || <tt>ashift</tt> || Controls the block size offset for the devices which can impact usable capacity and performance. Recommend leaving this at 0 so that the system can automatically select based on the reported blocksize of the devices.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 5,045: Line 5,341:




===provisioning-quota-share-add===
===pool-destroy===
Adds one or more shares to the specified provisioning quota.
Deletes a storage pool, *WARNING* any data in the pool will be lost.


<pre> qs provisioning-quota-share-add|pqs-add --quota=value --share-list=value [--flags=value ] </pre>
<pre> qs pool-destroy|p-destroy --pool=value [--shred-keys=value ] [--shred-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>shred-keys</tt> || Shreds the keys if the pool is an encrypted Storage Pool.
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &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 command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===provisioning-quota-share-assoc-list===
===pool-device-get===
Returns a list of all the associated provisioning quotas of a specified share.
Gets information about a specific storage pool device.


<pre> qs provisioning-quota-share-assoc-list|pqs-alist --share=value [--flags=value ] </pre>
<pre> qs pool-device-get|spd-get --pool-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>pool-device</tt> || Name or UUID of a storage pool device
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===provisioning-quota-share-remove===
===pool-device-group-get===
Removes one or more shares from the specified provisioning quota.
Gets information about a specific storage pool device group.


<pre> qs provisioning-quota-share-remove|pqs-remove --quota=value --share-list=value [--flags=value ] </pre>
<pre> qs pool-device-group-get|spdg-get --pool-device-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===provisioning-quota-volume-add===
===pool-device-group-identify===
Adds one or more volumes to the specified provisioning quota.
Pulses the disk activity lights for all disks in the pool device group so they can be identified in the chassis.


<pre> qs provisioning-quota-volume-add|pqv-add --quota=value --volume-list=value [--flags=value ] </pre>
<pre> qs pool-device-group-identify|spdg-ident --pool-device-group=value [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===provisioning-quota-volume-assoc-list===
===pool-device-group-list===
Returns a list of all the associated provisioning quotas of a specified volume.
Returns a list of all the storage pool device groups.


<pre> qs provisioning-quota-volume-assoc-list|pqv-alist --volume=value [--flags=value ] </pre>
<pre> qs pool-device-group-list|spdg-list [--pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 5,111: Line 5,409:




===provisioning-quota-volume-remove===
===pool-device-group-search===
Removes one or more volumes from the specified provisioning quota
Returns a subset of Storage Pool Device Group objects matching the given search criteria.


<pre> qs provisioning-quota-volume-remove|pqv-remove --quota=value --volume-list=value [--flags=value ] </pre>
<pre> qs pool-device-group-search|spdg-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Storage Pool Device Group List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===replica-assoc-delete===
===pool-device-list===
Deletes the specified replication association between a source/target pair of volumes or shares.
Returns a list of all the storage pool devices.


<pre> qs replica-assoc-delete|rep-assoc-delete --replica-assoc=value [--flags=value ] </pre>
<pre> qs pool-device-list|spd-list [--pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===replica-assoc-get===
===pool-device-search===
Returns details of the specified replication association.
Returns a subset of Storage Pool Device objects matching the given search criteria.


<pre> qs replica-assoc-get|rep-assoc-get --replica-assoc=value [--flags=value ] </pre>
<pre> qs pool-device-search|spd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Storage Pool Device List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===replica-assoc-list===
===pool-expand===
Returns a list of all the replication associations.
Expands a storage pool after the underlying hardware RAID unit has been grown underneath.


<pre> qs replica-assoc-list|rep-assoc-list [--flags=value ] </pre>
<pre> qs pool-expand|p-expand --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-assoc-rollback===
===pool-export===
Reverses the replication to send the changes on the target back to the source volume/share.  Requires the --force flag.
Deactivate and removes the storage pool from the Storage System database so that it can be exported and used on another system.


<pre> qs replica-assoc-rollback|rep-assoc-rollback --replica-assoc=value [--flags=value ] </pre>
<pre> qs pool-export|p-export --pool=value [--release-io-fence=value ] [--metadata-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
|-
| &nbsp; || <tt>metadata-only</tt> || Export a new metadata archive to the '.poolmeta' directory for the specified pool. The pool is not exported, rather this option provides for a way to make a new explicit backup of pool metadata.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-assoc-stop===
===pool-get===
Attempts to stop the replication process between a source/target pair of volumes or shares.
Gets information about a specific storage pool.


<pre> qs replica-assoc-stop|rep-assoc-stop --replica-assoc=value [--flags=value ] </pre>
<pre> qs pool-get|p-get --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, forget-missing, min]
|}
|}




===replica-assoc-sync===
===pool-grow===
Restarts the replication process between a source/target pair of volumes or shares.
Grows the specified storage pool by adding an additional disk.  You can only grow storage pools that are using the RAID5 or RAID6 layout.


<pre> qs replica-assoc-sync|rep-assoc-sync --replica-assoc=value [--flags=value ] </pre>
<pre> qs pool-grow|p-grow --pool=value --disk-list=value [--raid-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-report-entry-get===
===pool-health-check===
Get a replication report entry.
Checks the health/state of the pool and recursively checks the health of the associated disk devices to see if there are any issues anywhere in the stack.


<pre> qs replica-report-entry-get|rep-report-get --report-entry=value [--flags=value ] </pre>
<pre> qs pool-health-check|p-check --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-entry</tt> || Name or ID of the replication report entry
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replica-report-entry-list===
===pool-identify===
Returns a list of replication report entry.
Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.


<pre> qs replica-report-entry-list|rep-report-list [--report-summary=value ] [--flags=value ] </pre>
<pre> qs pool-identify|p-id --pool=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
| &nbsp; || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-report-summary-delete===
===pool-import===
Delete a replication report summary. All the report entries for this summary will be deleted.
Imports the named storage pool(s) which have been previously exported.


<pre> qs replica-report-summary-delete|rep-report-summary-delete --report-summary=value [--flags=value ] </pre>
<pre> qs pool-import|p-import --pool-list=value [--storage-system=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool.  Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
|-
| &nbsp; || <tt>skip-metadata</tt> || Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory.  Useful for when the metadata is too old or invalid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-report-summary-get===
===pool-import-encrypted===
Get a replication report summary.
Imports the named encrypted storage pool(s) which have been previously exported, providing the given passphrase to decrypt the pool.


<pre> qs replica-report-summary-get|rep-report-summary-get --report-summary=value [--flags=value ] </pre>
<pre> qs pool-import-encrypted|p-import-crypt --storage-system=value --pool-list=value [--passphrase=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>passphrase</tt> || 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.
|-
| &nbsp; || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool.  Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
|-
| &nbsp; || <tt>skip-metadata</tt> || Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory.  Useful for when the metadata is too old or invalid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replica-report-summary-list===
===pool-key-export===
Returns a list of replication report summary.
Exports all the encryption key information for the specified Storage Pool into a block that can be used in the future to re-import the keys.


<pre> qs replica-report-summary-list|rep-report-summary-list [--schedule=value ] [--flags=value ] </pre>
<pre> qs pool-key-export|p-key-export --pool=value --key-file=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>key-file</tt> || File name to use for the exported pool key block.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replication-schedule-activate-checkpoints===
===pool-key-import===
Activates all the Network Shares and Storage Volumes associated with the schedule as 'active replica checkpoints'. This stops the schedule from running and makes it clear to the user (see green dot in WUI and isActiveCheckpoint) that the share/volume is in use by the DR site. Optionally a subset of volumes/shares may be selected to be activated.  Note also that SMB/NFS/iSCSI/FC login to a given _chkpnt marked share or volume will automatically transition it to the Active Checkpoint state.  This Active Checkpoint state must be cleared for all shares/volumes in a given Replication Schedule before the schedule can resume automatic replication.
Import the previously exported encryption keys for a Storage Pool to the specified Storage System.


<pre> qs replication-schedule-activate-checkpoints|rsch-act-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--auto-alias=value ] [--flags=value ] </pre>
<pre> qs pool-key-import|p-key-import --key-file=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>key-file</tt> || File which contains the previously exported key block to use for importing.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &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>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>auto-alias</tt> || Creates Network Share aliases for all of the Network Share checkpoints so that they may be accessed using the name of the source Network Share rather than a share with the _chkpnt suffix.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replication-schedule-add===
===pool-list===
Adds one or more volumes/shares to the specified schedule.
Returns a list of all the storage pools.


<pre> qs replication-schedule-add|rsch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
<pre> qs pool-list|p-list [--vasa-support-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>vasa-support-only</tt> || VASA support only.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===replication-schedule-create===
===pool-modify===
Creates a new replication schedule to replicate the specified Storage Volumes and shares to the specified target pool on a schedule.
Modifies the properties of the storage pool such as its name and description.


<pre> 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 ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] </pre>
<pre> qs pool-modify|p-modify --pool=value [--name=value ] [--is-default=value ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--desc=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--repair-policy=value ] [--approve-repair=value ] [--copies=value ] [--key-server-profile=value ] [--key-server-type=value ] [--small-block-threshold=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>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>target-pool</tt> || Target storage pool on remote system to replicate to.
| &nbsp; || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &nbsp; || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
|-
|-
| &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>profile</tt> || 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.
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>sync</tt> || 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]
|-
|-
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
| &nbsp; || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|-
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
| &nbsp; || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
| &nbsp; || <tt>repair-policy</tt> || Type of automatic hotspare repair action to be applied. (assigned-and-global | assigned-only | assigned-and-global-exact | assigned-only-exact | manual-repair) [*assigned-and-global, assigned-and-global-exact, assigned-only, assigned-only-exact, manual]
|-
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>approve-repair</tt> || 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
|-
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
| &nbsp; || <tt>copies</tt> || 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).
|-
| &nbsp; || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
| &nbsp; || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|-
| &nbsp; || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
| &nbsp; || <tt>key-server-type</tt> || Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
|-
|-
| &nbsp; || <tt>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
| &nbsp; || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|}
|}




===replication-schedule-deactivate-checkpoints===
===pool-preimport-scan===
Deactivates all the Network Shares and Storage Volumes associated with the schedule so that the schedule can resume automatic replication.  If there are active sessions to any Volumes/Shares the schedule will not be able to be re-enabled.
Returns a list of pools that are available to import but that are not yet discovered.


<pre> qs replication-schedule-deactivate-checkpoints|rsch-deact-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--reenable=value ] [--flags=value ] </pre>
<pre> qs pool-preimport-scan|ppi-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>reenable</tt> || Re-enables the schedule so that automatic replication can resume.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replication-schedule-delete===
===pool-profile-get===
Deletes a replication schedule, snapshots associated with the schedule are not removed.
Gets information about a specific storage pool profile.


<pre> qs replication-schedule-delete|rsch-delete --schedule=value [--flags=value ] </pre>
<pre> qs pool-profile-get|pp-get --profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>profile</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===replication-schedule-disable===
===pool-profile-list===
Disables the specified replication schedule.
Returns a list of all the storage pool profiles.


<pre> qs replication-schedule-disable|rsch-disable --schedule=value [--flags=value ] </pre>
<pre> qs pool-profile-list|pp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===replication-schedule-enable===
===pool-rekey===
Enables the specified replication schedule.
Add a new key to availible LUKS key slot. Creates a back up of valid previously used key and generates key materials for the new key.


<pre> qs replication-schedule-enable|rsch-enable --schedule=value [--flags=value ] </pre>
<pre> qs pool-rekey|p-rekey --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replication-schedule-get===
===pool-remove-read-cache===
Returns information about a specific replication schedule.
Removes the specified read cache from the specified pool.


<pre> qs replication-schedule-get|rsch-get --schedule=value [--flags=value ] </pre>
<pre> qs pool-remove-read-cache|p-remove-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replication-schedule-list===
===pool-remove-spare===
Returns a list of all the replication schedules.
Removes the specified hot-spare from the specified pool.


<pre> qs replication-schedule-list|rsch-list [--flags=value ] </pre>
<pre> qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===replication-schedule-modify===
===pool-remove-write-log===
Modifies the name, description or other properties of a replication schedule.
Removes the specified write log from the specified pool.


<pre> qs replication-schedule-modify|rsch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] </pre>
<pre> qs pool-remove-write-log|p-remove-write-log --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|-
| &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>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===pool-scan===
Rescans the specified Storage System for storage pools.
 
<pre> qs pool-scan|p-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|}
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
 
|-
 
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
===pool-scrub-start===
Starts a scrub/verify operation on a ZFS-based Storage Pool (verifies data integrity and auto-corrects any bit-rot). See 'zpool scrub' 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>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
| &nbsp; || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
|-
| &nbsp; || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
|-
| &nbsp; || <tt>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|}
|}




===replication-schedule-remove===
===pool-scrub-stop===
Removes one or more volumes/shares from the specified schedule.
Stops the an active scrub/verify operation on a ZFS-based Storage Pool.


<pre> qs replication-schedule-remove|rsch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
<pre> qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===replication-schedule-trigger===
===pool-search===
Triggers the specified schedule to run immediately.
Returns a subset of Storage Pools matching the given search criteria.


<pre> qs replication-schedule-trigger|rsch-trigger --schedule=value [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--flags=value ] </pre>
<pre> qs pool-search|p-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Storage Pool List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>


==Report Schedule Management [REPORT-SCHEDULE]==
===pool-set-passphrase===
Operations for sending automatic email reports on a schedule.
Sets or clears the encryption passphrase for an encrypted storage pool.
<div class='mw-collapsible'>
 
<div class='mw-collapsible-content'>
<pre> qs pool-set-passphrase|p-set-passphrase --pool=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>current-passphrase</tt> || Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
|-
| &nbsp; || <tt>new-passphrase</tt> || New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 


===report-schedule-add-pool===
===pool-start===
Adds pools to the Report Schedule for usage and capacity reports.
Starts up a previously stopped storage pool.


<pre> qs report-schedule-add-pool|rs-add-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
<pre> qs pool-start|p-start --pool=value [--passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
| &nbsp; || <tt>passphrase</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===report-schedule-assoc-get===
===pool-stop===
Gets detailed information on a specific Report Schedule Association
Stops all volume activity to the pool and disables it for maintenance.


<pre> qs report-schedule-assoc-get|rs-assoc-get --report-schedule=value --pool=value [--flags=value ] </pre>
<pre> qs pool-stop|p-stop --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &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>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===report-schedule-assoc-list===
===pool-trim===
Returns a list of all the Report Schedule associations to Pools
Starts a trim operation on a ZFS-based Storage Pool. See 'zpool trim' command for additional control.


<pre> qs report-schedule-assoc-list|rs-assoc-list --report-schedule=value [--flags=value ] </pre>
<pre> qs pool-trim|p-trim --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===report-schedule-create===
===qos-policy-create===
Creates a new Report Schedule
Creates a new Quality-of-Service (QoS) policy template, which is used to apply throughput performance limits on Storage Volumes.


<pre> qs report-schedule-create|rs-create --name=value --interval-days=value --days=value --hours=value [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--start-date=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--pool-list=value ] [--flags=value ] </pre>
<pre> qs qos-policy-create|qos-create --name=value --bw-read=value --bw-write=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>bw-read</tt> || 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.
|-
|-
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
| &nbsp; || <tt>bw-write</tt> || 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.
|-
|-
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, usage]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
| &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>interval-days</tt> || Delay interval in days between when a schedule run completes and the next one is started.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots.
|-
| &nbsp; || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours.
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===report-schedule-delete===
===qos-policy-delete===
Deletes the specified Report Schedule
Deletes a given QoS Policy and clears the QoS performance limits on all Storage Volumes associated with the policy.


<pre> qs report-schedule-delete|rs-delete --report-schedule=value [--flags=value ] </pre>
<pre> qs qos-policy-delete|qos-delete --qos-policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>qos-policy</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===report-schedule-disable===
===qos-policy-get===
Disables the specified Report Schedule
Returns detailed information about a specific QoS policy.


<pre> qs report-schedule-disable|rs-disable --report-schedule=value [--flags=value ] </pre>
<pre> qs qos-policy-get|qos-get --qos-policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>qos-policy</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===report-schedule-enable===
===qos-policy-list===
Enables the specified Report Schedule
Returns details on the list of all QoS policy objects in the Storage System grid.


<pre> qs report-schedule-enable|rs-enable --report-schedule=value [--flags=value ] </pre>
<pre> qs qos-policy-list|qos-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===report-schedule-get===
===qos-policy-modify===
Returns details of a specific Report Schedule
Modifies an existing QoS policy with a new name, description, or performance limits. Changes are applied immediately to all volumes.


<pre> qs report-schedule-get|rs-get --report-schedule=value [--flags=value ] </pre>
<pre> qs qos-policy-modify|qos-modify --qos-policy=value [--name=value ] [--desc=value ] [--bw-read=value ] [--bw-write=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>qos-policy</tt> || 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.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>bw-read</tt> || 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.
|-
| &nbsp; || <tt>bw-write</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>


===report-schedule-list===
==Resource Group Quota Management [QUOTA]==
Returns a list of all the Report Schedules
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
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


<pre> qs report-schedule-list|rs-list [--flags=value ] </pre>
===provisioning-quota-create===
{| cellspacing='0' cellpadding='5'
Creates a new storage provisioning quota on a pool for the specified tenant resource cloud.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===report-schedule-modify===
Modifies the specified Report Schedule


<pre> qs report-schedule-modify|rs-modify --report-schedule=value [--name=value ] [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--flags=value ] </pre>
<pre> qs provisioning-quota-create|pq-create --name=value --pool=value --resource-group=value [--policy=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
| &nbsp; || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
|-
|-
| &nbsp; || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, usage]
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
| &nbsp; || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
|-
|-
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
| &nbsp; || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
|-
|-
| &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>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
|-
|-
| &nbsp; || <tt>interval-days</tt> || Delay interval in days between when a schedule run completes and the next one is started.
| &nbsp; || <tt>max-shares</tt> || The maximum number of share that can be created using this quota, specify 0 for no limit.
|-
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours.
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===report-schedule-remove-pool===
===provisioning-quota-delete===
Removes pools from the Report Schedule for usage and capacity reports.
Deletes a storage provisioning quota, the associated volumes are not deleted.


<pre> qs report-schedule-remove-pool|rs-remove-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
<pre> qs provisioning-quota-delete|pq-delete --quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===report-schedule-trigger===
===provisioning-quota-get===
Triggers the specified Report Schedule to immediately send a report.
Returns information about a specific storage provisioning quota.


<pre> qs report-schedule-trigger|rs-trigger --report-schedule=value [--flags=value ] </pre>
<pre> qs provisioning-quota-get|pq-get --quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===system-report===
===provisioning-quota-list===
Generate a configuration analysis health report of all Storage Systems in the grid.
Returns a list of all the storage provisioning quotas.


<pre> qs system-report|sys-report [--report-type=value ] [--config-category=value ] [--output-format=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--pool-list=value ] [--flags=value ] </pre>
<pre> qs provisioning-quota-list|pq-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>report-type</tt> || Type of report to generate. [capacity, health, *none, usage]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===provisioning-quota-modify===
Modifies one to change the name and/or description of a storage provisioning quota.
 
<pre> qs provisioning-quota-modify|pq-modify --quota=value --resource-group=value [--name=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--policy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>config-category</tt> || Category of commands to get help with (all, network, HA, remote-replication, ceph, zfs, cephfs, HA-cluster, grid, security, general, hw-maint). [*ALL, HA, hw-maint, network, platform, remote-replication, security]
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
| &nbsp; || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
|-
|-
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
| &nbsp; || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
|-
|-
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
| &nbsp; || <tt>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
|-
|-
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
| &nbsp; || <tt>max-shares</tt> || The maximum number of share that can be created using this quota, specify 0 for no limit.
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
| &nbsp; || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}


</div>
</div>


==Resource Domain Management [RESOURCE-DOMAIN]==
===provisioning-quota-share-add===
Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH) can be automatically configured.
Adds one or more shares to the specified provisioning quota.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===resource-domain-add-system===
<pre> qs provisioning-quota-share-add|pqs-add --quota=value --share-list=value [--flags=value ] </pre>
Adds one or more systems to a resource domain (site, rack, etc).
 
<pre> qs resource-domain-add-system|rd-add-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|-
| &nbsp; || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===resource-domain-assoc-get===
===provisioning-quota-share-assoc-list===
Returns information about a system/appliance association with a specific domain (rack, building, site).
Returns a list of all the associated provisioning quotas of a specified share.


<pre> qs resource-domain-assoc-get|rda-get [--system-resource=value ] [--resource-domain-assoc=value ] [--flags=value ] </pre>
<pre> qs provisioning-quota-share-assoc-list|pqs-alist --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>system-resource</tt> || Storage system to be associated to a resource domain (site, rack, building) for use in automatic CRUSH map generation.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>resource-domain-assoc</tt> || Resource domain association between a system and a resource domain (site, rack, building) for use in automatic CRUSH map generation.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 5,802: Line 6,043:




===resource-domain-assoc-list===
===provisioning-quota-share-remove===
Returns a list of all the defined resource domain association objects which represent links between appliances to sites, buildings, and racks.
Removes one or more shares from the specified provisioning quota.


<pre> qs resource-domain-assoc-list|rda-list [--flags=value ] </pre>
<pre> qs provisioning-quota-share-remove|pqs-remove --quota=value --share-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===resource-domain-create===
===provisioning-quota-volume-add===
Creates a new resource domain which identifies a site, building or rack of equipment.
Adds one or more volumes to the specified provisioning quota.


<pre> qs resource-domain-create|rd-create --name=value [--desc=value ] [--resource-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
<pre> qs provisioning-quota-volume-add|pqv-add --quota=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &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>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===resource-domain-delete===
===provisioning-quota-volume-assoc-list===
Deletes the specified resource domain.
Returns a list of all the associated provisioning quotas of a specified volume.


<pre> qs resource-domain-delete|rd-delete --domain-resource=value [--flags=value ] </pre>
<pre> qs provisioning-quota-volume-assoc-list|pqv-alist --volume=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===resource-domain-get===
===provisioning-quota-volume-remove===
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.
Removes one or more volumes from the specified provisioning quota


<pre> qs resource-domain-get|rd-get --domain-resource=value [--flags=value ] </pre>
<pre> qs provisioning-quota-volume-remove|pqv-remove --quota=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
| &nbsp; || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===resource-domain-list===
==Remote Replication Management [REPLICATION]==
Returns a list of all the defined resource domain objects which can include sites, buildings, racks, and servers.
Remote-replication and associated replication schedules enable automatic replication to a pool of storage in a remote appliance for disaster-recovery (DR) purposes.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===replica-assoc-delete===
Deletes the specified replication association between a source/target pair of volumes or shares.


<pre> qs resource-domain-list|rd-list [--flags=value ] </pre>
<pre> qs replica-assoc-delete|rep-assoc-delete --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===resource-domain-modify===
===replica-assoc-get===
Modifies an existing resource domain to change properties like name and description.
Returns details of the specified replication association.


<pre> qs resource-domain-modify|rd-modify --domain-resource=value [--name=value ] [--desc=value ] [--resource-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
<pre> qs replica-assoc-get|rep-assoc-get --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===replica-assoc-list===
Returns a list of all the replication associations.
 
<pre> qs replica-assoc-list|rep-assoc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &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>flags</tt> || Optional flags for the operation. [async]
|}
|}




===resource-domain-rm-system===
===replica-assoc-rollback===
Removes one or more systems from a resource domain (site, rack, etc)
Reverses the replication to send the changes on the target back to the source volume/share.  Requires the --force flag.


<pre> qs resource-domain-rm-system|rd-rm-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
<pre> qs replica-assoc-rollback|rep-assoc-rollback --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
| &nbsp; || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Multitenant Resource Group Management [RESOURCE-GROUP]==
===replica-assoc-stop===
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.
Attempts to stop the replication process between a source/target pair of volumes or shares.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===resource-group-create===
<pre> qs replica-assoc-stop|rep-assoc-stop --replica-assoc=value [--flags=value ] </pre>
Creates a new tenant resource group comprised of the specified users, resources and chap information.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
|}
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
 
 
===replica-assoc-sync===
Restarts the replication process between a source/target pair of volumes or shares.
 
<pre> qs replica-assoc-sync|rep-assoc-sync --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
| &nbsp; || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|-
| &nbsp; || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===replica-report-entry-get===
Get a replication report entry.
 
<pre> qs replica-report-entry-get|rep-report-get --report-entry=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || The tier of the storage cloud.
| &nbsp; || <tt>report-entry</tt> || Name or ID of the replication report entry
|-
|-
| &nbsp; || <tt>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===resource-group-delete===
===replica-report-entry-list===
Deletes a tenant's resource group, the resources and users will not be deleted.
Returns a list of replication report entry.


<pre> qs resource-group-delete|rg-delete --cloud=value [--flags=value ] </pre>
<pre> qs replica-report-entry-list|rep-report-list [--report-summary=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===resource-group-get===
===replica-report-summary-delete===
Returns information of the specified tenant resource groups.
Delete a replication report summary. All the report entries for this summary will be deleted.


<pre> qs resource-group-get|rg-get --cloud=value [--flags=value ] </pre>
<pre> qs replica-report-summary-delete|rep-report-summary-delete --report-summary=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===resource-group-list===
===replica-report-summary-get===
Returns a list of all the tenant resource groups.
Get a replication report summary.


<pre> qs resource-group-list|rg-list [--flags=value ] </pre>
<pre> qs replica-report-summary-get|rep-report-summary-get --report-summary=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===resource-group-modify===
===replica-report-summary-list===
Modifies the name, description, parent resource group, tier, organization, and chap information of a resource group.
Returns a list of replication report summary.


<pre> 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 ] </pre>
<pre> qs replica-report-summary-list|rep-report-summary-list [--schedule=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
|}
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
|-
| &nbsp; || <tt>tier</tt> || The tier of the storage cloud.
|-
| &nbsp; || <tt>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}




===resource-group-resource-add===
===replication-schedule-activate-checkpoints===
Add one or more resources to the specified tenant resource group.
Activates all the Network Shares and Storage Volumes associated with the schedule as 'active replica checkpoints'. This stops the schedule from running and makes it clear to the user (see green dot in WUI and isActiveCheckpoint) that the share/volume is in use by the DR site. Optionally a subset of volumes/shares may be selected to be activated.  Note also that SMB/NFS/iSCSI/FC login to a given _chkpnt marked share or volume will automatically transition it to the Active Checkpoint state.  This Active Checkpoint state must be cleared for all shares/volumes in a given Replication Schedule before the schedule can resume automatic replication.


<pre> qs resource-group-resource-add|rgr-add --cloud=value --resource-list=value [--flags=value ] </pre>
<pre> qs replication-schedule-activate-checkpoints|rsch-act-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--auto-alias=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
| &nbsp; || <tt>auto-alias</tt> || Creates Network Share aliases for all of the Network Share checkpoints so that they may be accessed using the name of the source Network Share rather than a share with the _chkpnt suffix.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===resource-group-resource-mode===
===replication-schedule-add===
Set the mode of a specified resource in the tenant resource group.
Adds one or more volumes/shares to the specified schedule.


<pre> qs resource-group-resource-mode|rgr-mode --cloud=value --resource=value --access-mode=value [--flags=value ] </pre>
<pre> qs replication-schedule-add|rsch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>resource</tt> || The unique id of a volume or volume group or share or host or host group.
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|-
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===resource-group-resource-remove===
===replication-schedule-create===
Remove one or more resource from the specified tenant resource group.
Creates a new replication schedule to replicate the specified Storage Volumes and shares to the specified target pool on a schedule.


<pre> qs resource-group-resource-remove|rgr-remove --cloud=value --resource-list=value [--flags=value ] </pre>
<pre> qs replication-schedule-create|rsch-create --name=value --target-pool=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
| &nbsp; || <tt>target-pool</tt> || Target storage pool on remote system to replicate to.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|}
 
 
===resource-group-subject-assoc-list===
Returns a list of associated tenant resource groups to the specified subject (user or user group).
 
<pre> qs resource-group-subject-assoc-list|rgsub-alist --subject=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>subject</tt> || The unique id of a user or user group.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &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)
|}
 
 
===resource-group-user-add===
Add one or more users to the specified tenant resource group.
 
<pre> qs resource-group-user-add|rgu-add --cloud=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|}
 
 
===resource-group-user-remove===
Remove one or more users from specified tenant resource group.
 
<pre> qs resource-group-user-remove|rgu-remove --cloud=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|-
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|}
 
</div>
</div>
 
==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).
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===password-policy-get===
Returns details of the current user password policy settings for the storage grid / appliances.
 
<pre> qs password-policy-get|pw-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|}
 
 
===password-policy-set===
Configures the password policy requirements for user accounts.
 
<pre> qs password-policy-set|pw-policy-set [--special-chars=value ] [--complexity=value ] [--min-length=value ] [--max-length=value ] [--login-attempts-short-lockout=value ] [--login-attempts-perm-lockout=value ] [--days-until-exp=value ] [--unique-pw-reuse=value ] [--min-days-between-change=value ] [--inactive-days-lockout=value ] [--web-logout-timeout=value ] [--use-note=value ] [--web-access=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>special-chars</tt> || Special characters which are allowed to be used in a password.
| &nbsp; || <tt>hours</tt> || (calendar based) 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>complexity</tt> || Password complexity requirement where 'strong' requires a mix of numbers, letters, and special characters. [standard, strong, *weak]
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
|-
| &nbsp; || <tt>min-length</tt> || Minimum password length (default 8)
| &nbsp; || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|-
| &nbsp; || <tt>max-length</tt> || Maximum password length (default 40)
| &nbsp; || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>login-attempts-short-lockout</tt> || Maximum password attempts before account is locked out for a short period. (default 5)
| &nbsp; || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>login-attempts-perm-lockout</tt> || Maximum password attempts before account is locked out and must be unlocked by an administrator. (default 0/disabled)
| &nbsp; || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>days-until-exp</tt> || Days until a user's password expires and must be changed. (default 0/disabled)
| &nbsp; || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>unique-pw-reuse</tt> || Number of unique passwords that must be used before it can be reused.
| &nbsp; || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|-
| &nbsp; || <tt>min-days-between-change</tt> || Minimum number of days before a password may be changed again.
| &nbsp; || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>inactive-days-lockout</tt> || After N many days without a successful login for a given account this policy will automatically lock the user account unless it is the admin account (default 0/disabled).
| &nbsp; || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>web-logout-timeout</tt> || After N many minutes of no activity in the web interface users will be logged out automatically. (default 30 minutes)
| &nbsp; || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>use-note</tt> || System use notification message is an administrator supplied message that is presented to the user immediately after login. System use notification messages are required in some corporate and government environments to meet compliance standards.
| &nbsp; || <tt>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>web-access</tt> || Unsecure HTTP access mode should be disabled or redirected to HTTPS in almost all configurations. [disable-http, *enable-http, redirect-http]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
| &nbsp; || <tt>rc-summary-reports</tt> || Number of replication summary reports to retain.
|-
| &nbsp; || <tt>include-nested-shares</tt> || Include nested shares.
|-
| &nbsp; || <tt>resumable-replication</tt> || Enable resumable replication. Defaults to true.
|}
|}




===role-add===
===replication-schedule-deactivate-checkpoints===
Adds a new role to the role based access control (RBAC) system.
Deactivates all the Network Shares and Storage Volumes associated with the schedule so that the schedule can resume automatic replication.  If there are active sessions to any Volumes/Shares the schedule will not be able to be re-enabled.


<pre> qs role-add|r-add --name=value [--desc=value ] [--permissions=value ] [--ldap-group=value ] [--flags=value ] </pre>
<pre> qs replication-schedule-deactivate-checkpoints|rsch-deact-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--reenable=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|-
| &nbsp; || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>ldap-group</tt> || LDAP group name associated with the role.
| &nbsp; || <tt>reenable</tt> || Re-enables the schedule so that automatic replication can resume.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===role-get===
===replication-schedule-delete===
Gets information about the specified role.
Deletes a replication schedule, snapshots associated with the schedule are not removed.


<pre> qs role-get|r-get --role=value [--export=value ] [--flags=value ] </pre>
<pre> qs replication-schedule-delete|rsch-delete --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>export</tt> || Export the role in XML format for use in the security definition file.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===role-list===
===replication-schedule-disable===
Returns a list of all the defined roles the RBAC system.
Disables the specified replication schedule.


<pre> qs role-list|r-list [--flags=value ] </pre>
<pre> qs replication-schedule-disable|rsch-disable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===role-modify===
===replication-schedule-enable===
Modifies the name and/or description of a role
Enables the specified replication schedule.


<pre> qs role-modify|r-modify --role=value [--name=value ] [--desc=value ] [--ldap-group=value ] [--flags=value ] </pre>
<pre> qs replication-schedule-enable|rsch-enable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>ldap-group</tt> || LDAP group name associated with the role.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===role-permission-add===
===replication-schedule-get===
Adds additional permissions and/or permission groups to the specified role.
Returns information about a specific replication schedule.


<pre> qs role-permission-add|rp-add --role=value --permissions=value [--flags=value ] </pre>
<pre> qs replication-schedule-get|rsch-get --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|-
| &nbsp; || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===role-permission-def-list===
===replication-schedule-list===
Returns a list of all the defined permissions available to be assigned to roles in the RBAC system.
Returns a list of all the replication schedules.


<pre> qs role-permission-def-list|rpd-list [--flags=value ] </pre>
<pre> qs replication-schedule-list|rsch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 6,214: Line 6,412:




===role-permission-remove===
===replication-schedule-modify===
Removes one or more permissions and/or permission groups from the specified role.
Modifies the name, description or other properties of a replication schedule.


<pre> qs role-permission-remove|rp-remove --role=value --permissions=value [--flags=value ] </pre>
<pre> qs replication-schedule-modify|rsch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &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>permissions</tt> || List of permissions and/or permission groups to add to the specified role.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|}
 
 
===role-remove===
Removes the specified role identified by name or ID
 
<pre> qs role-remove|r-remove --role=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|}
 
 
===single-sign-on-policy-get===
Gets the Single Sign-on Policy
 
<pre> qs single-sign-on-policy-get|sso-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|}
 
 
===single-sign-on-policy-set===
Sets the Single Sign-on Policy
 
<pre> qs single-sign-on-policy-set|sso-policy-set --enable-single-sign-on=value [--ldap-server-fqdn=value ] [--ldap-server-base-dn=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>enable-single-sign-on</tt> || Enable Single Sign-on
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|-
| &nbsp; || <tt>ldap-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the LDAP server. Example ldapserver.example.com
| &nbsp; || <tt>hours</tt> || (calendar based) 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>ldap-server-base-dn</tt> || LDAP server base DN for users. Example dc=ldapserver,dc=example,dc=com
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|}
|-
 
| &nbsp; || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
</div>
|-
</div>
| &nbsp; || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
 
|-
==Commands for S3 object storage setup and S3 user management. [S3]==
| &nbsp; || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===s3-object-pool-group-create===
Creates a new S3 Object Storage Pool Group/Zone within the specified Ceph Cluster to enable S3 Object Storage capabilities.
 
<pre> qs s3-object-pool-group-create|zone-create --ceph-cluster=value [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--ec-pool-profile=value ] [--sys-list=value ] [--use-case=value ] [--scaling-factor=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|-
| &nbsp; || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
| &nbsp; || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>object-store-zone-group</tt> || Ceph object storage zone group. (Default: 'default')
| &nbsp; || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>pool-type</tt> || Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5. Default is replicated.
| &nbsp; || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
|-
|-
| &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>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
|-
|-
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|-
| &nbsp; || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
|-
| &nbsp; || <tt>use-case</tt> || Default use case is S3 object storage but Openstack based pools may also be created in addition. [*s3, s3+openstack]
| &nbsp; || <tt>rc-summary-reports</tt> || Number of replication summary reports to retain.
|-
|-
| &nbsp; || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
| &nbsp; || <tt>include-nested-shares</tt> || Include nested shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>resumable-replication</tt> || Enable resumable replication. Defaults to true.
|}
|}




===s3-object-pool-group-delete===
===replication-schedule-remove===
Deletes the specified object pool group, WARNING all associated objects in the pool group will be destroyed.
Removes one or more volumes/shares from the specified schedule.


<pre> qs s3-object-pool-group-delete|zone-delete --ceph-object-pool-group=value [--flags=value ] </pre>
<pre> qs replication-schedule-remove|rsch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===s3-object-pool-group-get===
===replication-schedule-trigger===
Returns information about a specific object storage pool group used to store S3 object data.
Triggers the specified schedule to run immediately.


<pre> qs s3-object-pool-group-get|zone-get --ceph-object-pool-group=value [--flags=value ] </pre>
<pre> qs replication-schedule-trigger|rsch-trigger --schedule=value [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
| &nbsp; || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
| &nbsp; || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot.  Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
| &nbsp; || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one.  This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>


===s3-object-pool-group-list===
==Report Schedule Management [REPORT-SCHEDULE]==
Returns a list of all the object storage pool groups.
Operations for sending automatic email reports on a schedule.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===report-schedule-add-pool===
Adds pools to the Report Schedule for usage and capacity reports.


<pre> qs s3-object-pool-group-list|zone-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs report-schedule-add-pool|rs-add-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 6,340: Line 6,529:




===s3-user-accesskey-add===
===report-schedule-assoc-get===
Adds a new S3 User Access Key to an existing S3 User in a Ceph Cluster.
Gets detailed information on a specific Report Schedule Association


<pre> qs s3-user-accesskey-add|s3k-add --s3-user=value [--s3-access-key=value ] [--s3-secret-key=value ] [--flags=value ] </pre>
<pre> qs report-schedule-assoc-get|rs-assoc-get --report-schedule=value --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>s3-access-key</tt> || The access key value of an S3 User Access Key.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>s3-secret-key</tt> || The secret key value of an S3 User Access Key.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===s3-user-accesskey-get===
===report-schedule-assoc-list===
Returns information about the specified S3 User Access Key.
Returns a list of all the Report Schedule associations to Pools


<pre> qs s3-user-accesskey-get|s3k-get --s3-user-access-key=value [--flags=value ] </pre>
<pre> qs report-schedule-assoc-list|rs-assoc-list --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===s3-user-accesskey-list===
===report-schedule-create===
Returns a list of all the S3 User Access Keys.
Creates a new Report Schedule


<pre> qs s3-user-accesskey-list|s3k-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs report-schedule-create|rs-create --name=value [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--pool-list=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
|}
 
 
===s3-user-accesskey-modify===
Modifies the secret key of an existing S3 User Access Key.
 
<pre> qs s3-user-accesskey-modify|s3k-modify --s3-user=value --s3-user-access-key=value [--s3-secret-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|-
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
| &nbsp; || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
|-
|-
| &nbsp; || <tt>s3-secret-key</tt> || The new secret key for the existing S3 User Access Key.
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|}
 
 
===s3-user-accesskey-remove===
Removes the S3 User Access Key from the existing S3 User in a Ceph Cluster.
 
<pre> qs s3-user-accesskey-remove|s3k-remove --s3-user=value --s3-user-access-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|-
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
| &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>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>interval-days</tt> || Delay interval in days between when a schedule run completes and the next one is started.
|}
 
 
===s3-user-create===
Creates a new S3 User to allow S3 protocol access to the S3 Object Storage Group/Zone.
 
<pre> qs s3-user-create|s3u-create --ceph-cluster=value --name=value --display-name=value [--tenant=value ] [--email=value ] [--s3-access-key=value ] [--s3-secret-key=value ] [--access-permission=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>hours</tt> || (calendar based) 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>display-name</tt> || Display name for the user.
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
|-
| &nbsp; || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
|-
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|-
| &nbsp; || <tt>s3-access-key</tt> || The access key value of an S3 User Access Key.
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|-
| &nbsp; || <tt>s3-secret-key</tt> || The secret key value of an S3 User Access Key.
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>access-permission</tt> || Ceph object storage permission (rwx, rw-, ---) [*all, delete, read, write]
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
| &nbsp; || <tt>max-users</tt> || Maximum users to be included in report for each tenant.
|-
|-
| &nbsp; || <tt>max-objects</tt> || Maximum object count per bucket.
| &nbsp; || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|-
| &nbsp; || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
| &nbsp; || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|-
| &nbsp; || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
|-
| &nbsp; || <tt>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
|-
| &nbsp; || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
|-
| &nbsp; || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
|-
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets a user can have / create.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===s3-user-delete===
===report-schedule-delete===
Deletes the specified S3 User.
Deletes the specified Report Schedule


<pre> qs s3-user-delete|s3u-delete --ceph-cluster=value --s3-user=value [--delete-data=value ] [--key-delete=value ] [--flags=value ] </pre>
<pre> qs report-schedule-delete|rs-delete --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
|}
| &nbsp; || <tt>delete-data</tt> || Flag to specify deletion of user data along with this operation. (Default : false)
 
|-
| &nbsp; || <tt>key-delete</tt> || Flag to specify deletion of user security keys along with this operation. (Default : false)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}


===report-schedule-disable===
Disables the specified Report Schedule


===s3-user-disable===
<pre> qs report-schedule-disable|rs-disable --report-schedule=value [--flags=value ] </pre>
Disable a previously active/enabled S3 User.
 
<pre> qs s3-user-disable|s3u-disable --s3-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===s3-user-enable===
===report-schedule-enable===
Enable a previously suspended S3 User.
Enables the specified Report Schedule


<pre> qs s3-user-enable|s3u-enable --s3-user=value [--flags=value ] </pre>
<pre> qs report-schedule-enable|rs-enable --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===s3-user-get===
===report-schedule-get===
Returns information about a specific object storage S3 User.
Returns details of a specific Report Schedule


<pre> qs s3-user-get|s3u-get --s3-user=value [--flags=value ] </pre>
<pre> qs report-schedule-get|rs-get --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
Line 6,510: Line 6,655:




===s3-user-list===
===report-schedule-list===
Returns a list of all the Ceph Object storage S3 Users and their associated S3 User Access Keys
Returns a list of all the Report Schedules


<pre> qs s3-user-list|s3u-list [--ceph-cluster=value ] [--flags=value ] </pre>
<pre> qs report-schedule-list|rs-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 6,522: Line 6,665:




===s3-user-modify===
===report-schedule-modify===
Modifies the name and permissions for a specified S3 User object.
Modifies the specified Report Schedule


<pre> qs s3-user-modify|s3u-modify --ceph-cluster=value --s3-user=value [--display-name=value ] [--email=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--flags=value ] </pre>
<pre> qs report-schedule-modify|rs-modify --report-schedule=value [--name=value ] [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>display-name</tt> || Display name for the user.
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|-
| &nbsp; || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
| &nbsp; || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
|-
|-
| &nbsp; || <tt>max-objects</tt> || Maximum object count per bucket.
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|-
| &nbsp; || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|-
| &nbsp; || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
| &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>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
| &nbsp; || <tt>interval-days</tt> || Delay interval in days between when a schedule run completes and the next one is started.
|-
|-
| &nbsp; || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|-
| &nbsp; || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
| &nbsp; || <tt>hours</tt> || (calendar based) 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>max-buckets</tt> || Maximum buckets a user can have / create.
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|}
 
</div>
</div>
 
==S3 Reverse Proxy Management [S3PROXY]==
Commands for managing S3 reverse proxies.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===s3proxy-create===
Creates a new S3 Reverse Proxy configuration on the specified system.
 
<pre> qs s3proxy-create|s3p-create --name=value --proxy-server-fqdn=value --proxy-endpoint-fqdn=value [--storage-system=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|-
| &nbsp; || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|-
| &nbsp; || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>max-users</tt> || Maximum users to be included in report for each tenant.
|-
|-
| &nbsp; || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
| &nbsp; || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|-
| &nbsp; || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
| &nbsp; || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|-
| &nbsp; || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===s3proxy-delete===
===report-schedule-remove-pool===
Deletes the specified S3 Reverse Proxy configuration.
Removes pools from the Report Schedule for usage and capacity reports.


<pre> qs s3proxy-delete|s3p-delete --s3proxy=value [--flags=value ] </pre>
<pre> qs report-schedule-remove-pool|rs-remove-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
| &nbsp; || <tt>pool-list</tt> || List of one or more storage pools.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===s3proxy-get===
===report-schedule-trigger===
Returns information about a specific S3 Reverse Proxy configuration.
Triggers the specified Report Schedule to immediately send a report.


<pre> qs s3proxy-get|s3p-get --s3proxy=value [--flags=value ] </pre>
<pre> qs report-schedule-trigger|rs-trigger --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
| &nbsp; || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===s3proxy-list===
===system-report===
Returns a list of all the configured S3 Reverse Proxies in the system/grid.
Generate a configuration analysis health report of all Storage Systems in the grid.


<pre> qs s3proxy-list|s3p-list [--storage-system=value ] [--flags=value ] </pre>
<pre> qs system-report|sys-report [--report-type=value ] [--config-category=value ] [--output-format=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>report-type</tt> || Type of report to generate. [capacity, health, *none, objectusage, replication, usage]
|-
| &nbsp; || <tt>config-category</tt> || Category of commands to get help with (all, network, HA, remote-replication, ceph, zfs, cephfs, HA-cluster, grid, security, general, hw-maint). [*ALL, HA, hw-maint, network, platform, remote-replication, security]
|-
| &nbsp; || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>report-email</tt> || Email address to send the report to.
|}
 
 
===s3proxy-modify===
Modifies the settings/properties of an S3 Reverse Proxy configuration.
 
<pre> qs s3proxy-modify|s3p-modify --s3proxy=value [--name=value ] [--proxy-server-fqdn=value ] [--proxy-endpoint-fqdn=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
| &nbsp; || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
|-
| &nbsp; || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
| &nbsp; || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|-
| &nbsp; || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
| &nbsp; || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|-
| &nbsp; || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
|-
| &nbsp; || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
| &nbsp; || <tt>max-users</tt> || Maximum users to be included in report for each tenant.
|-
|-
| &nbsp; || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
| &nbsp; || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


Line 6,657: Line 6,779:
</div>
</div>


==Snapshot Schedule Management [SCHEDULE]==
==Resource Domain Management [RESOURCE-DOMAIN]==
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.
Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH) can be automatically configured.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===snap-schedule-add===
===resource-domain-add-system===
Adds one or more volumes/shares to the specified schedule.
Adds one or more systems to a resource domain (site, rack, etc).


<pre> qs snap-schedule-add|sch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
<pre> qs resource-domain-add-system|rd-add-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===snap-schedule-assoc-list===
===resource-domain-assoc-get===
Returns a list of all the volume/share associations for a given snapshot schedule.
Returns information about a system/appliance association with a specific domain (rack, building, site).


<pre> qs snap-schedule-assoc-list|scha-list --schedule=value [--flags=value ] </pre>
<pre> qs resource-domain-assoc-get|rda-get [--system-resource=value ] [--resource-domain-assoc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>system-resource</tt> || Storage system to be associated to a resource domain (site, rack, building) for use in automatic CRUSH map generation.
|-
| &nbsp; || <tt>resource-domain-assoc</tt> || Resource domain association between a system and a resource domain (site, rack, building) for use in automatic CRUSH map generation.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 6,690: Line 6,812:




===snap-schedule-create===
===resource-domain-assoc-list===
Creates a new snapshot schedule comprised of the specified Storage Volumes.
Returns a list of all the defined resource domain association objects which represent links between appliances to sites, buildings, and racks.


<pre> 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 ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] </pre>
<pre> qs resource-domain-assoc-list|rda-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
|}
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
 
 
===resource-domain-create===
Creates a new resource domain which identifies a site, building or rack of equipment.
 
<pre> qs resource-domain-create|rd-create --name=value [--desc=value ] [--resource-domain-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &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>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>resource-domain-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
|-
|-
| &nbsp; || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
| &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>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
Line 6,736: Line 6,840:




===snap-schedule-delete===
===resource-domain-delete===
Deletes a snapshot schedule, snapshots associated with the schedule are not removed.
Deletes the specified resource domain.


<pre> qs snap-schedule-delete|sch-delete --schedule=value [--flags=value ] </pre>
<pre> qs resource-domain-delete|rd-delete --domain-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
Line 6,748: Line 6,852:




===snap-schedule-disable===
===resource-domain-get===
Disables the specified snapshot schedule.
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.


<pre> qs snap-schedule-disable|sch-disable --schedule=value [--flags=value ] </pre>
<pre> qs resource-domain-get|rd-get --domain-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===snap-schedule-enable===
===resource-domain-list===
Enables the specified snapshot schedule.
Returns a list of all the defined resource domain objects which can include sites, buildings, racks, and servers.


<pre> qs snap-schedule-enable|sch-enable --schedule=value [--flags=value ] </pre>
<pre> qs resource-domain-list|rd-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===snap-schedule-get===
===resource-domain-modify===
Returns information about a specific snapshot schedule.
Modifies an existing resource domain to change properties like name and description.


<pre> qs snap-schedule-get|sch-get --schedule=value [--flags=value ] </pre>
<pre> qs resource-domain-modify|rd-modify --domain-resource=value [--name=value ] [--desc=value ] [--resource-domain-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>resource-domain-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>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===snap-schedule-list===
===resource-domain-rm-system===
Returns a list of all the snapshot schedules.
Removes one or more systems from a resource domain (site, rack, etc)


<pre> qs snap-schedule-list|sch-list [--flags=value ] </pre>
<pre> qs resource-domain-rm-system|rd-rm-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
| &nbsp; || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===snap-schedule-modify===
==Multitenant Resource Group Management [RESOURCE-GROUP]==
Modifies the name, description or other properties of a snapshot schedule.
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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===resource-group-create===
Creates a new tenant resource group comprised of the specified users, resources and chap information.


<pre> qs snap-schedule-modify|sch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--cloud=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] </pre>
<pre> qs resource-group-create|rg-create --name=value --network-list=value [--desc=value ] [--subject-list=value ] [--resource-list=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--scope=value ] [--scope-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &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>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>cloud</tt> || Name of a Storage Cloud or its unique id.
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|-
| &nbsp; || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|-
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
| &nbsp; || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
| &nbsp; || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
|-
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
| &nbsp; || <tt>tier</tt> || The tier of the storage cloud.
|-
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
|-
|-
| &nbsp; || <tt>offset-minutes</tt> || (calendar based) 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.
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|-
| &nbsp; || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|-
| &nbsp; || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
| &nbsp; || <tt>scope</tt> || Scope for the Resource Group
|-
|-
| &nbsp; || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
| &nbsp; || <tt>scope-type</tt> || Scope type for the Resource Group [Ceph, HA, *local]
|-
|-
| &nbsp; || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===resource-group-delete===
Deletes a tenant's resource group, the resources and users will not be deleted.
 
<pre> qs resource-group-delete|rg-delete --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===snap-schedule-remove===
===resource-group-get===
Removes one or more volumes/shares from the specified schedule.
Returns information of the specified tenant resource groups.


<pre> qs snap-schedule-remove|sch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
<pre> qs resource-group-get|rg-get --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===snap-schedule-trigger===
===resource-group-list===
Triggers the specified schedule to run immediately.
Returns a list of all the tenant resource groups.


<pre> qs snap-schedule-trigger|sch-trigger --schedule=value [--flags=value ] </pre>
<pre> qs resource-group-list|rg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


</div>
</div>


==iSCSI/FC/NFS/SMB Session Management [SESSION]==
===resource-group-modify===
Commands for iSCSI/FC/NFS/SMB storage session management.
Modifies the name, description, parent resource group, tier, organization, and chap information of a resource group.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===share-session-get===
Returns information about a specific NFS/SMB session.


<pre> qs share-session-get|share-sn-get --share-session=value [--flags=value ] </pre>
<pre> qs resource-group-modify|rg-modify --resource-group=value [--name=value ] [--desc=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share-session</tt> || A Network Share session represents a NAS client connection/session via the SMB and/or NFS protocol.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
|-
| &nbsp; || <tt>tier</tt> || The tier of the storage cloud.
|-
| &nbsp; || <tt>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-session-list===
===resource-group-network-add===
Returns a list of all the open NFS and SMB sessions.
Add one or more network access points to the specified tenant resource group


<pre> qs share-session-list|share-sn-list [--storage-system=value ] [--flags=value ] </pre>
<pre> qs resource-group-network-add|rg-net-add --resource-group=value --network-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===volume-session-close===
===resource-group-network-enum===
Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.
Returns list of all resource group network access bindings.


<pre> qs volume-session-close|volume-sn-close [--volume=value ] [--session-list=value ] [--flags=value ] </pre>
<pre> qs resource-group-network-enum|rg-net-enum [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>session-list</tt> || iSCSI session identifier for an active iSCSI session.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===volume-session-get===
===resource-group-network-get===
Returns detailed information on a specific iSCSI session.
Returns specified resource group network access binding.


<pre> qs volume-session-get|volume-sn-get --session=value [--flags=value ] </pre>
<pre> qs resource-group-network-get|rg-net-get --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>session</tt> || iSCSI session identifier for an active iSCSI session.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===volume-session-list===
===resource-group-network-remove===
Returns a list of all the active iSCSI sessions.
Remove one or more network access points from the specified tenant resource group


<pre> qs volume-session-list|volume-sn-list [--volume=value ] [--host=value ] [--flags=value ] </pre>
<pre> qs resource-group-network-remove|rg-net-remove --resource-group=value --network-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
| &nbsp; || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


==Network Share Management [SHARE]==
===resource-group-resource-add===
Commands for managing Network Shares which are accessible via NFS and/or the SMB protocol.
Add one or more resources to the specified tenant resource group.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===active-dir-domain-list===
Returns a list of all domains including the trusted domains.


<pre> qs active-dir-domain-list|ad-dom-list --storage-system=value [--flags=value ] </pre>
<pre> qs resource-group-resource-add|rg-res-add --resource-group=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===active-dir-user-group-list===
===resource-group-resource-mode===
Returns a list of all the users and groups in the Active Directory domain that the appliance is a member of. Search result is limited to 1000 users/groups. Consider narrowing down the search for a list of all users/groups
Set the mode of a specified resource in the tenant resource group.


<pre> qs active-dir-user-group-list|ad-ug-list --storage-system=value [--is-group=value ] [--domain=value ] [--organization-unit=value ] [--filter=value ] [--flags=value ] </pre>
<pre> qs resource-group-resource-mode|rg-res-mode --resource-group=value --resource=value --access-mode=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>resource</tt> || The unique id of a volume or volume group or share or host or host group.
|-
|-
| &nbsp; || <tt>is-group</tt> || List active directory users or groups. Default is users
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume.
|-
|-
| &nbsp; || <tt>domain</tt> || Search users or groups in the specified domain. If not specified the default domain will be used.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===resource-group-resource-remove===
Remove one or more resource from the specified tenant resource group.
 
<pre> qs resource-group-resource-remove|rg-res-remove --resource-group=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>organization-unit</tt> || Search users or groups in the specified organization unit. If not specified, the base domain will be used to search.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>filter</tt> || Filter to search users or groups. Example user*dom*. If not specified, all users or groups will be search.
| &nbsp; || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===share-client-add===
===resource-group-subject-assoc-list===
Adds a NFS client access rule for the specified Network Share.
Returns a list of associated tenant resource groups to the specified subject (user or user group).


<pre> qs share-client-add|shr-cadd --share=value --filter=value [--async=value ] [--secure=value ] [--subtree=value ] [--rdonly=value ] [--options=value ] [--flags=value ] </pre>
<pre> qs resource-group-subject-assoc-list|rg-user-list --subject=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>subject</tt> || The unique id of a user or user group.
|-
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===resource-group-user-add===
Add one or more users to the specified tenant resource group.
 
<pre> qs resource-group-user-add|rg-user-add --resource-group=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>async</tt> || Use asynchronous communication between NFS server and client
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|-
| &nbsp; || <tt>subtree</tt> || Enables subtree checking
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===resource-group-user-remove===
Remove one or more users from specified tenant resource group.
 
<pre> qs resource-group-user-remove|rg-user-remove --resource-group=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>rdonly</tt> || Allow only read requests for the NFS volume
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|-
| &nbsp; || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
| &nbsp; || <tt>subject-list</tt> || A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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).
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===share-client-get===
===login-precheck===
Returns information about the specific Network Share NFS client access rule.
Returns basic service startup information usable before attempting login or commands.


<pre> qs share-client-get|shr-cget --share=value [--filter=value ] [--flags=value ] </pre>
<pre> qs login-precheck|lpc [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===share-client-list===
===password-policy-get===
Returns a list of NFS clients access rules for the specified Network Share.
Returns details of the current user password policy settings for the storage grid / appliances.


<pre> qs share-client-list|shr-clist --share=value [--flags=value ] </pre>
<pre> qs password-policy-get|pw-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-client-modify===
===password-policy-set===
Modifies a NFS client access rule for the specified Network Share.
Configures the password policy requirements for user accounts.


<pre> qs share-client-modify|shr-cmodify --share=value --filter=value [--rdonly=value ] [--secure=value ] [--async=value ] [--subtree=value ] [--options=value ] [--flags=value ] </pre>
<pre> qs password-policy-set|pw-policy-set [--special-chars=value ] [--complexity=value ] [--min-length=value ] [--max-length=value ] [--login-attempts-short-lockout=value ] [--login-attempts-perm-lockout=value ] [--short-lockout-sample-sec=value ] [--perm-lockout-sample-sec=value ] [--short-lockout-duration=value ] [--days-until-exp=value ] [--unique-pw-reuse=value ] [--min-days-between-change=value ] [--inactive-days-lockout=value ] [--web-logout-timeout=value ] [--use-note=value ] [--web-access=value ] [--default-login-username=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>special-chars</tt> || Special characters which are allowed to be used in a password.
|-
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
| &nbsp; || <tt>complexity</tt> || Password complexity requirement where 'strong' requires a mix of numbers, letters, and special characters. [standard, strong, *weak]
|-
|-
| &nbsp; || <tt>rdonly</tt> || Allow only read requests for the NFS volume
| &nbsp; || <tt>min-length</tt> || Minimum password length (default 8)
|-
|-
| &nbsp; || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
| &nbsp; || <tt>max-length</tt> || Maximum password length (default 40)
|-
|-
| &nbsp; || <tt>async</tt> || Use asynchronous communication between NFS server and client
| &nbsp; || <tt>login-attempts-short-lockout</tt> || Maximum password attempts before account is locked out for a short period. (default 5)
|-
|-
| &nbsp; || <tt>subtree</tt> || Enables subtree checking
| &nbsp; || <tt>login-attempts-perm-lockout</tt> || Maximum password attempts before account is locked out and must be unlocked by an administrator. (default 0/disabled)
|-
| &nbsp; || <tt>short-lockout-sample-sec</tt> || Continuous sample period (in seconds) over which bad login attempts are summed to determine if a short lockout to a User account should be applied.
|-
|-
| &nbsp; || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
| &nbsp; || <tt>perm-lockout-sample-sec</tt> || Continuous sample period (in seconds) over which bad login attempts are summed to determine if a permanent lockout to a User account should be applied.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>short-lockout-duration</tt> || Duration of the short lockout due to bad login attempts.
|}
 
 
===share-client-remove===
Removes NFS client access rule for the specified Network Share.
 
<pre> qs share-client-remove|shr-cremove --share=value --filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>days-until-exp</tt> || Days until a user's password expires and must be changed. (default 0/disabled)
|-
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
| &nbsp; || <tt>unique-pw-reuse</tt> || Number of unique passwords that must be used before it can be reused.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>min-days-between-change</tt> || Minimum number of days before a password may be changed again.
|}
 
 
===share-clone===
Creates a full copy of the specified Network Share to another storage pool.
 
<pre> qs share-clone|shr-clone --share=value --pool=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>inactive-days-lockout</tt> || After N many days without a successful login for a given account this policy will automatically lock the user account unless it is the admin account (default 0/disabled).
|-
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
| &nbsp; || <tt>web-logout-timeout</tt> || After N many minutes of no activity in the web interface users will be logged out automatically. (default 30 minutes)
|-
|-
| &nbsp; || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
| &nbsp; || <tt>use-note</tt> || System use notification message is an administrator supplied message that is presented to the user immediately after login.  System use notification messages are required in some corporate and government environments to meet compliance standards.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>web-access</tt> || Unsecure HTTP access mode should be disabled or redirected to HTTPS in almost all configurations. [disable-http, *enable-http, redirect-http]
|-
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
| &nbsp; || <tt>default-login-username</tt> || Default login username presented when logging in via the web management interface.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===share-create===
===role-add===
Creates a new Network Share accessible via NFS v3/v4 and the SMB protocol.
Adds a new role to the role based access control (RBAC) system.


<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 ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--reserved=value ] [--vvol-type=value ] [--protocol-end-point=value ] [--is-cloud-container-cache=value ] [--nfs-security-policy=value ] [--parent-share=value ] [--count=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--flags=value ] </pre>
<pre> qs role-add|r-add --name=value [--desc=value ] [--permissions=value ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
| &nbsp; || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
| &nbsp; || <tt>ldap-group</tt> || LDAP group name associated with the role.
|-
|-
| &nbsp; || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
| &nbsp; || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|-
| &nbsp; || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|-
| &nbsp; || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties. If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===role-get===
Gets information about the specified role.
 
<pre> qs role-get|r-get --role=value [--export=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
| &nbsp; || <tt>export</tt> || Export the role in XML format for use in the security definition file.
|-
|-
| &nbsp; || <tt>sync</tt> || 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]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
 
 
===role-list===
Returns a list of all the defined roles the RBAC system.
 
<pre> qs role-list|r-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4)
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===role-modify===
Modifies the name and/or description of a role
 
<pre> qs role-modify|r-modify --role=value [--name=value ] [--desc=value ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>copies</tt> || 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).
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>share-owner</tt> || Name of the share owner
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>permissions</tt> || 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--
| &nbsp; || <tt>ldap-group</tt> || LDAP group name associated with the role.
|-
|-
| &nbsp; || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
| &nbsp; || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|-
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|-
| &nbsp; || <tt>vvol-type</tt> || vvol type for VASA support. Type can be none for no VASA support, protocolEndPoint or subVol. Default is none. [*none, protocol-end-point, subvol-config, subvol-data, subvol-swap]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===role-permission-add===
Adds additional permissions and/or permission groups to the specified role.
 
<pre> qs role-permission-add|rp-add --role=value --permissions=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>protocol-end-point</tt> || Protocol Endpoint ID only applies to VVOL based Network Shares and indicates the parent share on which the VVOL should be created.
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
| &nbsp; || <tt>is-cloud-container-cache</tt> || Indicates if this share is to be used as Cloud Container cache. 'true' if used as a cache.
|-
| &nbsp; || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
|-
| &nbsp; || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
|-
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
| &nbsp; || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|-
| &nbsp; || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-create-alias===
===role-permission-def-list===
Creates an alias for the specified share.  Aliases have their own separate permissions settings which can be customized and can inherit from it's associated parent share.
Returns a list of all the defined permissions available to be assigned to roles in the RBAC system.


<pre> qs share-create-alias|shr-create-alias --name=value --parent-share=value [--subpath=value ] [--inherit-access=value ] [--desc=value ] [--public=value ] [--active=value ] [--force-create-sub-dir=value ] [--flags=value ] </pre>
<pre> qs role-permission-def-list|rpd-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
| &nbsp; || <tt>subpath</tt> || Sub-directory within the parent share to associate with this sub-share.  If the directory doesn't exist it will be created automatically and the sub-path can refer to a directory which is nested multiple levels deep.
|-
| &nbsp; || <tt>inherit-access</tt> || Inherit access control settings from the parent share including the NFS access entries and CIFS user/group access entries. [cifs, nfs, *none]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
| &nbsp; || <tt>force-create-sub-dir</tt> || Force creation of sub directory if not present. Without this option existing directory will not be used if present.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-delete===
===role-permission-remove===
Deletes the specified Network Share
Removes one or more permissions and/or permission groups from the specified role.


<pre> qs share-delete|shr-delete --share=value [--delete-child-snaps=value ] [--flags=value ] </pre>
<pre> qs role-permission-remove|rp-remove --role=value --permissions=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>delete-child-snaps</tt> || Deletes the child snapshots of the specified share/volume.
| &nbsp; || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-disable===
===role-remove===
Disables/deactivates the specified Network Share
Removes the specified role identified by name or ID


<pre> qs share-disable|shr-disable --share=value [--flags=value ] </pre>
<pre> qs role-remove|r-remove --role=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===share-enable===
===single-sign-on-policy-get===
Enables/activates the specified Network Share
Gets the Single Sign-on Policy


<pre> qs share-enable|shr-enable --share=value [--flags=value ] </pre>
<pre> qs single-sign-on-policy-get|sso-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-file-lock-list===
===single-sign-on-policy-set===
Returns a list of all the open files (SMB only) for the specified Network Share.
Sets the Single Sign-on Policy


<pre> qs share-file-lock-list|shr-lock-list [--share=value ] [--flags=value ] </pre>
<pre> qs single-sign-on-policy-set|sso-policy-set --enable-single-sign-on=value [--ldap-server-fqdn=value ] [--ldap-server-base-dn=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>enable-single-sign-on</tt> || Enable Single Sign-on
|-
| &nbsp; || <tt>ldap-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the LDAP server. Example ldapserver.example.com
|-
| &nbsp; || <tt>ldap-server-base-dn</tt> || LDAP server base DN for users. Example dc=ldapserver,dc=example,dc=com
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>


===share-get===
==Commands for S3 object storage setup and S3 user management. [S3]==
Returns information about the specified Network Share.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


<pre> qs share-get|shr-get --share=value [--flags=value ] </pre>
===s3-object-pool-group-create===
Creates a new S3 Object Storage Pool Group/Zone within the specified Ceph Cluster to enable S3 Object Storage capabilities.
 
<pre> qs s3-object-pool-group-create|zone-create [--ceph-cluster=value ] [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--scaling-factor=value ] [--auto-config-nfs=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>object-store-zone-group</tt> || Ceph object storage zone group. (Default: 'default')
|}
 
 
===share-group-quota-add===
Set a group quota for the Network Share
 
<pre> qs share-group-quota-add|shr-group-quota-add --share=value --user-group=value --quota-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'.  Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &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>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|}
 
 
===share-group-quota-remove===
Remove a group quota for the Network Share
 
<pre> qs share-group-quota-remove|shr-group-quota-remove --share=value --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &nbsp; || <tt>ec-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]
| &nbsp; || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|}
 
 
===share-health-check===
Checks the health/state of the share and recursively checks the health of the associated pool and it's disk devices to see if there are any health issues anywhere in the stack.
 
<pre> qs share-health-check|shr-check --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>auto-config-nfs</tt> || Auto configure NFS services for scale-out storage.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-join-domain===
===s3-object-pool-group-create-storage-class===
Joins the specified Active Directory domain/realm.
Creates a data pool for a Storage Class in the given Object Pool Group.


<pre> qs share-join-domain|shr-jdomain --storage-system=value --domain=value --realm=value --kdc=value --ad-admin=value --ad-password=value [--idmap-mode=value ] [--allow-trusted-domains=value ] [--computer-act-ou=value ] [--min-uid=value ] [--max-uid=value ] [--min-def-uid=value ] [--max-def-uid=value ] [--range-size=value ] [--flags=value ] </pre>
<pre> qs s3-object-pool-group-create-storage-class|zone-create-storage-class --ceph-object-pool-group=value --storage-class-name=value [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--ceph-cluster=value ] [--custom-storage-class-name=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|-
| &nbsp; || <tt>domain</tt> || The name of the AD domain to have the Storage System join. (DOMAIN)
| &nbsp; || <tt>storage-class-name</tt> || storage-class-name
|-
|-
| &nbsp; || <tt>realm</tt> || The name of the AD realm that the domain is in. (DOMAIN.COM)
| &nbsp; || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|-
| &nbsp; || <tt>kdc</tt> || The name of the Active Directory server/machine.
| &nbsp; || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|-
| &nbsp; || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
| &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>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
| &nbsp; || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'.  Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
|-
|-
| &nbsp; || <tt>idmap-mode</tt> || Specifies the Unix to Active Directory ID mapping mode (idmap config) of rid, autorid, tdb, ad, ad-rfc2307 [ad, ad-rfc2307, autorid, rid, *tdb]
| &nbsp; || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|-
| &nbsp; || <tt>allow-trusted-domains</tt> || Allow discovery of trusted domains (default=false)
| &nbsp; || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|-
| &nbsp; || <tt>computer-act-ou</tt> || Organization Unit to create the computer account in
| &nbsp; || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|-
| &nbsp; || <tt>min-uid</tt> || Min UID in the range
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>max-uid</tt> || Max UID in the range
| &nbsp; || <tt>custom-storage-class-name</tt> || Providing this argument will skip the checks for officially supported S3 storage class names. [ STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE ]
|-
|-
| &nbsp; || <tt>min-def-uid</tt> || Max UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===s3-object-pool-group-delete===
Deletes the specified object pool group, WARNING all associated objects in the pool group will be destroyed.
 
<pre> qs s3-object-pool-group-delete|zone-delete --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>max-def-uid</tt> || Min UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
| &nbsp; || <tt>range-size</tt> || Defines the number of uids/gids available per domain range. Only used in idmap mode 'autorid'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-leave-domain===
===s3-object-pool-group-get===
Leaves the current Active Directory domain.
Returns information about a specific object storage pool group used to store S3 object data.


<pre> qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--preserve-access-entries=value ] [--flags=value ] </pre>
<pre> qs s3-object-pool-group-get|zone-get --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|-
| &nbsp; || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
|-
| &nbsp; || <tt>preserve-access-entries</tt> || When a system is removed from an AD domain all local storage pools will have their AD user access control information scrubbed from all Network Shares unless preserve entries is specified.  (default=true)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-list===
===s3-object-pool-group-list===
Returns a list of all the Network Shares in the system.
Returns a list of all the object storage pool groups.


<pre> qs share-list|shr-list [--vasa-support-only=value ] [--flags=value ] </pre>
<pre> qs s3-object-pool-group-list|zone-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vasa-support-only</tt> || VASA support only.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===share-modify===
===s3-object-pool-group-modify===
Modifies the properties of the specified Network Share.
Modifies the settings for the object pool group.


<pre> 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 ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--is-active-checkpoint=value ] [--reserved=value ] [--nfs-security-policy=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--flags=value ] </pre>
<pre> qs s3-object-pool-group-modify|zone-modify --ceph-object-pool-group=value [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
| &nbsp; || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
|-
|-
| &nbsp; || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
| &nbsp; || <tt>object-store-zone-group</tt> || Ceph object storage zone group. (Default: 'default')
|-
|-
| &nbsp; || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
|}
| &nbsp; || <tt>sync</tt> || 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]
 
|-
 
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4)
===s3-object-pool-group-multi-site-setup===
|-
Setup multi site S3 Object Zone
| &nbsp; || <tt>copies</tt> || 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).
 
|-
<pre> qs s3-object-pool-group-multi-site-setup|zone-multi-site-setup --primary-object-pool-group=value --secondary-object-pool-group=value --primary-rados-gateway=value --secondary-rados-gateway=value [--flags=value ] </pre>
| &nbsp; || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
|-
| &nbsp; || <tt>group-access-list</tt> || 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.
|-
| &nbsp; || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.  If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
|-
| &nbsp; || <tt>share-owner</tt> || Name of the share owner
|-
| &nbsp; || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
|-
| &nbsp; || <tt>permissions</tt> || 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--
|-
| &nbsp; || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
|-
| &nbsp; || <tt>is-active-checkpoint</tt> || Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system.  Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage session.
|-
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|-
| &nbsp; || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
| &nbsp; || <tt>primary-object-pool-group</tt> || Primary Object Storage Pool for Multi Site Setup
|-
|-
| &nbsp; || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
| &nbsp; || <tt>secondary-object-pool-group</tt> || Secondary Object Storage Pool Group for Multi Site Setup
|-
|-
| &nbsp; || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
| &nbsp; || <tt>primary-rados-gateway</tt> || Primary Rados Gateway for Multi Site Setup
|-
|-
| &nbsp; || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
| &nbsp; || <tt>secondary-rados-gateway</tt> || Secondary Rados Gateway for Multi Site Setup
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-quota-list===
===s3-object-pool-group-multi-site-unconfigure===
Returns the user quotas for the Network Share.
Remove pool group from a multi site setup.


<pre> qs share-quota-list|shr-quota-list --share=value [--flags=value ] </pre>
<pre> qs s3-object-pool-group-multi-site-unconfigure|zone-multi-site-unconfigure --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===share-restore===
===s3-object-storage-class-get===
Restores the specified Network Share with the contents of the specified snapshot.
Returns information about a specific object storage class used to store S3 object data.


<pre> qs share-restore|shr-restore --share=value [--flags=value ] </pre>
<pre> qs s3-object-storage-class-get|osc-get --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>storage-class</tt> || Ceph object storage-classes enable tagging of S3 objects to specific Ceph Pool(s).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===share-rollback===
===s3-object-storage-class-list===
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.
Returns a list of all the object storage class.


<pre> qs share-rollback|shr-rollback --share=value --share-snapshot=value [--flags=value ] </pre>
<pre> qs s3-object-storage-class-list|osc-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-snapshot===
===s3-object-storage-class-rule-add===
Creates and instant space efficient snapshot of the specified Network Share (requires Advanced Storage Pool)
Adds Storage Class rules for dynamically auto-tiering S3 objects.


<pre> qs share-snapshot|shr-snap --share=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] </pre>
<pre> qs s3-object-storage-class-rule-add|oscr-add --rule-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>rule-list</tt> || List of Storage Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-user-quota-add===
===s3-object-storage-class-rule-get===
Set a user quota for the Network Share
Returns information about a specific object storage class rules used to store S3 object data in a specific Ceph Pool.


<pre> qs share-user-quota-add|shr-user-quota-add --share=value --user=value --quota-size=value [--flags=value ] </pre>
<pre> qs s3-object-storage-class-rule-get|oscr-get --storage-class-rule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>storage-class-rule</tt> || Ceph object storage-class rules enables automatic tagging of objects to specific storage classes based on size and name match pattern.
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===share-user-quota-remove===
===s3-object-storage-class-rule-list===
Remove a user quota for the Network Share.
Returns a list of all the object storage class rules.


<pre> qs share-user-quota-remove|shr-user-quota-remove --share=value --user=value [--flags=value ] </pre>
<pre> qs s3-object-storage-class-rule-list|oscr-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>
==Site Cluster Resource Management [SITE]==
Site Clusters manage virtual interfaces to which can float between cluster members to ensure high-availability to Storage Pools and other resources.  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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===cluster-ring-create===
===s3-object-storage-class-rule-remove===
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.
Removes specified Storage Class rules for dynamically auto-tiering S3 objects.


<pre> qs cluster-ring-create|cr-create --site=value --member-addresses=value [--ring=value ] [--bind-address=value ] [--flags=value ] </pre>
<pre> qs s3-object-storage-class-rule-remove|oscr-remove --rule-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>rule-list</tt> || List of Storage Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
|-
|-
| &nbsp; || <tt>member-addresses</tt> || IP addresses, one from each appliance, used to form a new cluster ring for cluster communication activities.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>ring</tt> || Unique cluster ring number starting with 0 for the first ring in the site.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|-
| &nbsp; || <tt>bind-address</tt> || The bind address represents the network on which cluster communication is allowed for a specific ring.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===cluster-ring-delete===
===s3-object-zone-get===
Deletes the specified cluster ring configuration.
Returns information about a specific object zone used to store S3 object data.


<pre> qs cluster-ring-delete|cr-delete --cluster-ring=value [--flags=value ] </pre>
<pre> qs s3-object-zone-get|s3-zone-get --ceph-object-zone=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cluster-ring</tt> || 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
| &nbsp; || <tt>ceph-object-zone</tt> || Ceph object zone.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===cluster-ring-get===
===s3-object-zone-group-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.
Returns information about a specific object zone group used to store S3 object data.


<pre> qs cluster-ring-get|cr-get --cluster-ring=value [--flags=value ] </pre>
<pre> qs s3-object-zone-group-get|zone-group-get --ceph-object-zone-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cluster-ring</tt> || 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
| &nbsp; || <tt>ceph-object-zone-group</tt> || Ceph object zone group.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===cluster-ring-list===
===s3-object-zone-group-list===
Returns a list of the cluster ring configurations.
Returns a list of all the object zone groups.


<pre> qs cluster-ring-list|cr-list [--flags=value ] </pre>
<pre> qs s3-object-zone-group-list|zone-group-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===cluster-ring-member-get===
===s3-object-zone-group-modify===
Returns information about the specified cluster ring member.
Set configuration values for a specific object zone group used to store S3 object data.


<pre> qs cluster-ring-member-get|crm-get --cluster-ring-member=value [--flags=value ] </pre>
<pre> qs s3-object-zone-group-modify|zone-group-modify --ceph-object-zone-group=value --hostname-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>cluster-ring-member</tt> || A cluster-ring-member represents a physical interface on a appliance used for cluster communication.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>ceph-object-zone-group</tt> || Ceph object zone group.
|-
| &nbsp; || <tt>hostname-list</tt> || A comma delimited list of hostnames, may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===cluster-ring-member-list===
===s3-object-zone-list===
Returns a list of all the cluster ring members of the site.
Returns a list of all the object zone.


<pre> qs cluster-ring-member-list|crm-list [--flags=value ] </pre>
<pre> qs s3-object-zone-list|s3-zone-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-cluster-add-nodes===
===s3-tenant-create===
Add the specified Storage Systems to the site cluster.
Creates a new tenant entry that can then be used to create S3 users under this tenant namespace.


<pre> qs site-cluster-add-nodes|sc-add-nodes --site=value --sys-list=value [--flags=value ] </pre>
<pre> qs s3-tenant-create|s3t-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>display-name</tt> || Display name for the user.
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-cluster-assoc-get===
===s3-tenant-delete===
Returns detailed information about the specified site association.
Deletes the specified S3 tenant.


<pre> qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] [--flags=value ] </pre>
<pre> qs s3-tenant-delete|s3t-delete --tenant=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>system</tt> || The system with the site association.
| &nbsp; || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===s3-tenant-get===
Gets information about the specified tenant.
 
<pre> qs s3-tenant-get|s3t-get --tenant=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site-assoc</tt> || A site association is a link between a system and a site.
| &nbsp; || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-cluster-assoc-list===
===s3-tenant-list===
Returns a list of all the configured site association.
Lists all the S3 tenants in the grid.


<pre> qs site-cluster-assoc-list|sca-list [--flags=value ] </pre>
<pre> qs s3-tenant-list|s3t-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-cluster-create===
===s3-user-accesskey-add===
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.
Adds a new S3 User Access Key to an existing S3 User in a Ceph Cluster.


<pre> qs site-cluster-create|sc-create --name=value --sys-list=value [--desc=value ] [--location=value ] [--flags=value ] </pre>
<pre> qs s3-user-accesskey-add|s3k-add --s3-user=value [--s3-access-key=value ] [--s3-secret-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of systems to be combined together to form a new site.
| &nbsp; || <tt>s3-access-key</tt> || The access key value of an S3 User Access Key.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>s3-secret-key</tt> || The secret key value of an S3 User Access Key.
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-cluster-delete===
===s3-user-accesskey-get===
Deletes the specified site configuration.
Returns information about the specified S3 User Access Key.


<pre> qs site-cluster-delete|sc-delete --site=value [--flags=value ] </pre>
<pre> qs s3-user-accesskey-get|s3k-get --s3-user-access-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===site-cluster-get===
===s3-user-accesskey-list===
Returns detailed information about the specified site.
Returns a list of all the S3 User Access Keys.


<pre> qs site-cluster-get|sc-get --site=value [--flags=value ] </pre>
<pre> qs s3-user-accesskey-list|s3k-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-cluster-list===
===s3-user-accesskey-modify===
Returns a list of all the configured sites.
Modifies the secret key of an existing S3 User Access Key.


<pre> qs site-cluster-list|sc-list [--flags=value ] </pre>
<pre> qs s3-user-accesskey-modify|s3k-modify --s3-user=value --s3-user-access-key=value [--s3-secret-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|}
 
 
===site-cluster-modify===
Modifies the configuration settings of a site like it's name, location or description.
 
<pre> qs site-cluster-modify|sc-modify --site=value [--name=value ] [--desc=value ] [--location=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>s3-secret-key</tt> || The new secret key for the existing S3 User Access Key.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
|}




===site-cluster-remove-nodes===
===s3-user-accesskey-remove===
Remove the specified Storage Systems from the site cluster.
Removes the S3 User Access Key from the existing S3 User in a Ceph Cluster.


<pre> qs site-cluster-remove-nodes|sc-remove-nodes --site=value --sys-list=value [--flags=value ] </pre>
<pre> qs s3-user-accesskey-remove|s3k-remove --s3-user=value --s3-user-access-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>s3-user-access-key</tt> || The name, UUID or access-key value used to identify a S3 User Access Key object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-cluster-rescan===
===s3-user-create===
Rescans the Site Cluster configuration for a given Site Cluster.
Creates a new S3 User to allow S3 protocol access to the S3 Object Storage Group/Zone.


<pre> qs site-cluster-rescan|sc-rescan [--site=value ] [--flags=value ] </pre>
<pre> qs s3-user-create|s3u-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--tenant=value ] [--email=value ] [--s3-access-key=value ] [--s3-secret-key=value ] [--access-permission=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--count=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>display-name</tt> || Display name for the user.
|}
 
 
===site-cluster-restart-services===
Restarts the corosync/pacemaker services on the specified appliance.
 
<pre> qs site-cluster-restart-services|sc-restart --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|}
|-
 
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
 
|-
===site-vif-create===
| &nbsp; || <tt>s3-access-key</tt> || The access key value of an S3 User Access Key.
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.
 
<pre> qs site-vif-create|svr-create --site=value --parent-port=value --ip-address=value [--netmask=value ] [--mac-address=value ] [--description=value ] [--location-config=value ] [--usecase-obj-id=value ] [--vif-use-case=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--mtu=value ] [--fqdn=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
| &nbsp; || <tt>s3-secret-key</tt> || The secret key value of an S3 User Access Key.
|-
|-
| &nbsp; || <tt>parent-port</tt> || 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.
| &nbsp; || <tt>access-permission</tt> || Ceph object storage permission (rwx, rw-, ---) [*all, delete, read, write]
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP address of the form x.x.x.x such as 10.0.0.10
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
|-
|-
| &nbsp; || <tt>mac-address</tt> || MAC Address
| &nbsp; || <tt>max-objects</tt> || Maximum object count per bucket.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
|-
|-
| &nbsp; || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
| &nbsp; || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
|-
|-
| &nbsp; || <tt>usecase-obj-id</tt> || Name or ID of the usecase object associated with this vif (ie, HA Group for a HA Vif, Ceph Cluster for a File pool Vif, etc)
| &nbsp; || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
|-
|-
| &nbsp; || <tt>vif-use-case</tt> || Specifies the use case in which the new vif shall be used. [grid-primary, *ha, other, s3proxy, scaleout-block, scaleout-file, scaleout-obj]
| &nbsp; || <tt>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
|-
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
| &nbsp; || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
|-
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
| &nbsp; || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
|-
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets a user can have / create.
|-
|-
| &nbsp; || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-vif-delete===
===s3-user-delete===
Deletes the virtual interface site resource and it's associated configuration information from the cluster configuration.
Deletes the specified S3 User.


<pre> qs site-vif-delete|svr-delete --vif-resource=value [--flags=value ] </pre>
<pre> qs s3-user-delete|s3u-delete --ceph-cluster=value --s3-user-list=value [--delete-data=value ] [--key-delete=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>s3-user-list</tt> || Comma delimited list of the Names or IDs of S3 Users.
|-
| &nbsp; || <tt>delete-data</tt> || Flag to specify deletion of user data along with this operation. (Default : false)
|-
| &nbsp; || <tt>key-delete</tt> || Flag to specify deletion of user security keys along with this operation. (Default : false)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-vif-get===
===s3-user-disable===
Returns the details about the specified virtual interface cluster resource in a site.
Disable a previously active/enabled S3 User.


<pre> qs site-vif-get|svr-get --vif-resource=value [--flags=value ] </pre>
<pre> qs s3-user-disable|s3u-disable --s3-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-vif-list===
===s3-user-enable===
Returns a list of all the virtual interface site resources.
Enable a previously suspended S3 User.


<pre> qs site-vif-list|svr-list [--flags=value ] </pre>
<pre> qs s3-user-enable|s3u-enable --s3-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===site-vif-location-constraint-get===
===s3-user-get===
Returns a specific location constraint for a Site Vif Resource given the Site Vif Resource and the associated Storage System Node.
Returns information about a specific object storage S3 User.


<pre> qs site-vif-location-constraint-get|sv-lc-get --vif-resource=value --storage-system=value [--flags=value ] </pre>
<pre> qs s3-user-get|s3u-get --s3-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===site-vif-location-constraint-list===
===s3-user-list===
Returns a list of all the location constraints for all Site Vif Resources.
Returns a list of all the Ceph Object storage S3 Users and their associated S3 User Access Keys


<pre> qs site-vif-location-constraint-list|sv-lc-list [--vif-resource=value ] [--flags=value ] </pre>
<pre> qs s3-user-list|s3u-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===site-vif-modify===
===s3-user-modify===
Updates a given Site Vif's use case, use case object, and/or location constraints.
Modifies the name and permissions for a specified S3 User object.


<pre> qs site-vif-modify|svr-modify --vif-resource=value [--description=value ] [--location-config=value ] [--flags=value ] </pre>
<pre> qs s3-user-modify|s3u-modify --ceph-cluster=value --s3-user=value [--display-name=value ] [--email=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>s3-user</tt> || Ceph object storage S3 User.
|-
| &nbsp; || <tt>display-name</tt> || Display name for the user.
|-
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
| &nbsp; || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
|-
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
| &nbsp; || <tt>max-objects</tt> || Maximum object count per bucket.
|-
|-
| &nbsp; || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
| &nbsp; || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
|}
 
 
===site-vif-move===
Moves the virtual interface resource from the current system it is attached to the specified Storage System.  The target Storage System must be a member of the site cluster configuration.
 
<pre> qs site-vif-move|svr-move --vif-resource=value --move-to-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
| &nbsp; || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
|-
|-
| &nbsp; || <tt>move-to-system</tt> || Destination system to move the virtual interface over to.
| &nbsp; || <tt>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
|}
|-
 
| &nbsp; || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
</div>
|-
</div>
| &nbsp; || <tt>max-buckets</tt> || Maximum buckets a user can have / create.
 
|-
==Storage Provisioning Tier Management [STORAGE-TIER]==
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
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.
|}
 
</div>
</div>
 
==S3 Reverse Proxy Management [S3PROXY]==
Commands for managing S3 reverse proxies.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===storage-tier-create===
===s3proxy-create===
Creates a new Storage Tier comprised of the specified storage pools
Creates a new S3 Reverse Proxy configuration on the specified system.


<pre> qs storage-tier-create|st-create --name=value --pool-list=value [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
<pre> qs s3proxy-create|s3p-create --name=value --proxy-server-fqdn=value --proxy-endpoint-fqdn=value [--storage-system=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
| &nbsp; || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
|-
| &nbsp; || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
|-
|-
| &nbsp; || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
| &nbsp; || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
|-
|-
| &nbsp; || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
| &nbsp; || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
|-
|-
| &nbsp; || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===storage-tier-delete===
===s3proxy-delete===
Deletes the specified Storage Tier (pools are not deleted).
Deletes the specified S3 Reverse Proxy configuration.


<pre> qs storage-tier-delete|st-delete --tier=value [--flags=value ] </pre>
<pre> qs s3proxy-delete|s3p-delete --s3proxy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===storage-tier-get===
===s3proxy-get===
Returns information about a specific Storage Tier.
Returns information about a specific S3 Reverse Proxy configuration.


<pre> qs storage-tier-get|st-get --tier=value [--flags=value ] </pre>
<pre> qs s3proxy-get|s3p-get --s3proxy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
|}




===storage-tier-list===
===s3proxy-list===
Returns a list of all the Storage Tiers.
Returns a list of all the configured S3 Reverse Proxies in the system/grid.


<pre> qs storage-tier-list|st-list [--flags=value ] </pre>
<pre> qs s3proxy-list|s3p-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===storage-tier-modify===
===s3proxy-modify===
Modifies the name, description or other property of the specified storage tier.
Modifies the settings/properties of an S3 Reverse Proxy configuration.


<pre> qs storage-tier-modify|st-modify --tier=value [--name=value ] [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
<pre> qs s3proxy-modify|s3p-modify --s3proxy=value [--name=value ] [--proxy-server-fqdn=value ] [--proxy-endpoint-fqdn=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
| &nbsp; || <tt>s3proxy</tt> || Name or ID of an S3 Reverse Proxy configuration.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
|-
| &nbsp; || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
|-
| &nbsp; || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
|-
|-
| &nbsp; || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
| &nbsp; || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
|-
|-
| &nbsp; || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
| &nbsp; || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
|-
|-
| &nbsp; || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===storage-tier-pool-add===
===snap-schedule-add===
Adds one or more pools to the specified storage tier.
Adds one or more volumes/shares to the specified schedule.


<pre> qs storage-tier-pool-add|stp-add --tier=value --pool-list=value [--flags=value ] </pre>
<pre> qs snap-schedule-add|sch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===storage-tier-pool-remove===
===snap-schedule-assoc-list===
Removes one or more pools from the specified storage tier.
Returns a list of all the volume/share associations for a given snapshot schedule.


<pre> qs storage-tier-pool-remove|stp-remove --tier=value --pool-list=value [--flags=value ] </pre>
<pre> qs snap-schedule-assoc-list|scha-list --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


</div>
</div>


==Software Controller / iSCSI SAN Adapter [SWC]==
===snap-schedule-create===
Storage Systems may connect to other SANs via iSCSI via the additon of one or more iSCSI Software Adapters/Controllers.
Creates a new snapshot schedule comprised of the specified Storage Volumes.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===sw-controller-add===
<pre> qs snap-schedule-create|sch-create --name=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ] </pre>
Adds an iSCSI or NVMe SAN adapter for connecting to the specified iSCSI or NVMe SAN.
{| cellspacing='0' cellpadding='5'
 
|-
<pre> qs sw-controller-add|swc-add --storage-system=value --name=value --ip-address=value --sw-controller-type=value [--desc=value ] [--port=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] </pre>
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &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>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>port</tt> || Port number for the Software Controller portal, defaults to 3260 if iSCSI, or 4420 if NVMe.
| &nbsp; || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>sw-controller-type</tt> || Protocol type of Software Controller. [*iscsi, nvme-rdma, nvme-tcp]
| &nbsp; || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>include-nested-shares</tt> || Include nested shares.
|}
|}




===sw-controller-autoconfig===
===snap-schedule-delete===
Creates all necessary hosts, Storage Volume assignments and iSCSI SAN adapters required to connect the specified systems to the specified Storage Volumes.
Deletes a snapshot schedule, snapshots associated with the schedule are not removed.


<pre> qs sw-controller-autoconfig|swc-autoconfig --sys-list=value --volume-list=value [--flags=value ] </pre>
<pre> qs snap-schedule-delete|sch-delete --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>volume-list</tt> || List of one or more Storage Volumes.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===sw-controller-get===
===snap-schedule-disable===
Gets detailed information about a specific software SAN controller.
Disables the specified snapshot schedule.


<pre> qs sw-controller-get|swc-get --sw-controller=value [--flags=value ] </pre>
<pre> qs snap-schedule-disable|sch-disable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===sw-controller-list===
===snap-schedule-enable===
Returns a list of all the configured software SAN adapter/controllers (iSCSI, etc).
Enables the specified snapshot schedule.


<pre> qs sw-controller-list|swc-list [--flags=value ] </pre>
<pre> qs snap-schedule-enable|sch-enable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|}
 
 
===sw-controller-remove===
Removes the specified iSCSI or NVMe SAN adapter
 
<pre> qs sw-controller-remove|swc-remove --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===sw-controller-scan===
===snap-schedule-get===
Scans the specified iSCSI/NVMe SAN adapter for iSCSI/NVMe targets.
Returns information about a specific snapshot schedule.


<pre> qs sw-controller-scan|swc-scan --sw-controller=value [--flags=value ] </pre>
<pre> qs snap-schedule-get|sch-get --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
 
 
===sw-controller-target===
Returns the specified software controller target.
 
<pre> qs sw-controller-target|swc-target --target=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>target</tt> || The software controller target to operate against
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 8,059: Line 8,154:




===sw-controller-target-list===
===snap-schedule-list===
Returns a list of all the discovered software controller targets.
Returns a list of all the snapshot schedules.


<pre> qs sw-controller-target-list|swc-target-list [--sw-controller=value ] [--flags=value ] </pre>
<pre> qs snap-schedule-list|sch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
Line 8,071: Line 8,164:




===sw-controller-target-login===
===snap-schedule-modify===
Logs into the specified targets on the specified iSCSI SAN adapter.
Modifies the name, description or other properties of a snapshot schedule.


<pre> qs sw-controller-target-login|swc-target-login --sw-controller=value --target-list=value [--flags=value ] </pre>
<pre> qs snap-schedule-modify|sch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>target-list</tt> || The list of targets for the software controller to operate against
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &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)
|}
 
 
===sw-controller-target-logout===
Logs out of the specified targets on the specified iSCSI SAN adapter.
 
<pre> qs sw-controller-target-logout|swc-target-logout --sw-controller=value --target-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|-
| &nbsp; || <tt>target-list</tt> || The list of targets for the software controller to operate against
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
| &nbsp; || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
| &nbsp; || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
| &nbsp; || <tt>schedule-type</tt> || Specifies the timer type for the schedule.  Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times.  Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
| &nbsp; || <tt>interval</tt> || (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
| &nbsp; || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
| &nbsp; || <tt>hours</tt> || (calendar based) 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>offset-minutes</tt> || (calendar based) 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.
|-
| &nbsp; || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
| &nbsp; || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|-
| &nbsp; || <tt>include-nested-shares</tt> || Include nested shares.
|}
|}




===sw-disk-session===
===snap-schedule-remove===
Returns the specified software disk session.
Removes one or more volumes/shares from the specified schedule.


<pre> qs sw-disk-session|swc-session --session=value [--flags=value ] </pre>
<pre> qs snap-schedule-remove|sch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>session</tt> || The software disk session to operate against
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===sw-disk-session-list===
===snap-schedule-trigger===
Returns a list of all software disk sessions.
Triggers the specified schedule to run immediately.


<pre> qs sw-disk-session-list|swc-session-list [--sw-controller=value ] [--flags=value ] </pre>
<pre> qs snap-schedule-trigger|sch-trigger --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
| &nbsp; || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 8,125: Line 8,240:
</div>
</div>


==Storage System Management [SYSTEM]==
==iSCSI/FC/NFS/SMB Session Management [SESSION]==
Commands for managing all the appliance centric settings including NTP, DNS servers, hostname, ARP policies, system restart, shutdown and more.
Commands for iSCSI/FC/NFS/SMB storage session management.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===enter-system-maintenance===
===share-session-get===
Set the Storage System(s) in Maintenance mode.
Returns information about a specific NFS/SMB session.


<pre> qs enter-system-maintenance|en-maint --sys-list=value [--enter=value ] [--flags=value ] </pre>
<pre> qs share-session-get|share-sn-get --share-session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>share-session</tt> || A Network Share session represents a NAS client connection/session via the SMB and/or NFS protocol.
|-
|-
| &nbsp; || <tt>enter</tt> || Flags to be passed to set one or more subsystem in the Storage System(s) in Maintenance Mode. [*all, ceph, corosync]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===exit-system-maintenance===
===share-session-list===
Get the Storage System(s) out of Maintenance mode.
Returns a list of all the open SMB sessions.
 
<pre> qs share-session-list|share-sn-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===volume-session-close===
Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.


<pre> qs exit-system-maintenance|ex-maint --sys-list=value [--exit=value ] [--flags=value ] </pre>
<pre> qs volume-session-close|volume-sn-close [--volume=value ] [--session-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>exit</tt> || Flags to be passed to move one or more subsystem in the Storage System(s) out of Maintenance Mode. [*all, ceph, corosync]
| &nbsp; || <tt>session-list</tt> || iSCSI session identifier for an active iSCSI session.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===system-get===
===volume-session-get===
Get general information about the Storage System.
Returns detailed information on a specific iSCSI session.


<pre> qs system-get|sys-get [--storage-system=value ] [--flags=value ] </pre>
<pre> qs volume-session-get|volume-sn-get --session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>session</tt> || iSCSI session identifier for an active iSCSI session.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 8,170: Line 8,295:




===system-list===
===volume-session-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.
Returns a list of all the active iSCSI sessions.


<pre> qs system-list|sys-list [--flags=value ] </pre>
<pre> qs volume-session-list|volume-sn-list [--volume=value ] [--host=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>
==Network Share Management [SHARE]==
Commands for managing Network Shares which are accessible via NFS and/or the SMB protocol.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===system-metadata-recovery-point-list===
===active-dir-domain-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.
Returns a list of all domains including the trusted domains.


<pre> qs system-metadata-recovery-point-list|smrp-list [--storage-system=value ] [--flags=value ] </pre>
<pre> qs active-dir-domain-list|ad-dom-list --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
|}




===system-modify===
===active-dir-user-group-list===
Modifies the name and/or description of the Storage System.
Returns a list of all the users and groups in the Active Directory domain that the appliance is a member of. Search result is limited to 1000 users/groups. Consider narrowing down the search for a list of all users/groups


<pre> qs system-modify|sys-modify --storage-system=value [--name=value ] [--desc=value ] [--location=value ] [--enclosure-layout=value ] [--domain-suffix=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--multipath-autoconfig=value ] [--hw-auto-maintenance=value ] [--log-collection=value ] [--eth-naming=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--disable-io-fencing=value ] [--flags=value ] </pre>
<pre> qs active-dir-user-group-list|ad-ug-list --storage-system=value [--is-group=value ] [--domain=value ] [--organization-unit=value ] [--filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &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>name</tt> || Storage system host name may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
| &nbsp; || <tt>is-group</tt> || List active directory users or groups. Default is users
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>domain</tt> || Search users or groups in the specified domain. If not specified the default domain will be used.
|-
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
| &nbsp; || <tt>organization-unit</tt> || Search users or groups in the specified organization unit. If not specified, the base domain will be used to search.
|-
|-
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
| &nbsp; || <tt>filter</tt> || Filter to search users or groups. Example user*dom*. If not specified, all users or groups will be search.
|-
|-
| &nbsp; || <tt>domain-suffix</tt> || The domain name suffix for your network such as example.com
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===share-client-add===
Adds a NFS client access rule for the specified Network Share.
 
<pre> qs share-client-add|shr-cadd --share=value --filter=value [--async=value ] [--secure=value ] [--subtree=value ] [--rdonly=value ] [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>search</tt> || The default domain search suffix for your network such as example.com
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>arp-filter-mode</tt> || ARP filtering should be enabled when you have more than one network card on the same network. [*auto, disabled, enabled]
| &nbsp; || <tt>filter</tt> || A filter string for the client
|-
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
| &nbsp; || <tt>async</tt> || Use asynchronous communication between NFS server and client
|-
|-
| &nbsp; || <tt>ext-hostname</tt> || Specifies the external hostname for the system.  This is useful for creating grids of systems in the cloud like in Amazon's EC2.
| &nbsp; || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
|-
|-
| &nbsp; || <tt>grid-port</tt> || Designated port for grid communication
| &nbsp; || <tt>subtree</tt> || Enables subtree checking
|-
|-
| &nbsp; || <tt>ntp-servers</tt> || Comma delimited list of NTP servers to assign to the appliance.
| &nbsp; || <tt>rdonly</tt> || Allow only read requests for the NFS volume
|-
|-
| &nbsp; || <tt>dns-servers</tt> || Comma delimited list of DNS servers to assign to the appliance.
| &nbsp; || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
|-
|-
| &nbsp; || <tt>multipath-autoconfig</tt> || When enabled multipathing is automatically configured for devices that support it. [disabled, enabled]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>hw-auto-maintenance</tt> || Flags to be passed to set one or more automatic repair modes in the Storage System's storage resources. [*none, osd, pool]
|-
| &nbsp; || <tt>log-collection</tt> || When enabled logs are sent periodically for automatic analysis. [biweekly, monthly, never, weekly]
|-
| &nbsp; || <tt>eth-naming</tt> || Applies either Predictable (Predictable Network Interface Naming/PNIN) port naming convention (ensN, enoN, enpN) or Unified (ethN) port naming convention.  Unified (ethN) based naming is the preferred mode as it applies a consistent naming across systems which is needed for highly available cluster VIF management. [*nochange, predictable, unified]
|-
| &nbsp; || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, iscsi, *nfs, restapi, smb]
|-
| &nbsp; || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
| &nbsp; || <tt>disable-io-fencing</tt> || Disables all I/O fencing operations on the system for all media devices. This should only be used on systems used in scale-out configurations and not scale-up HA pool configurations which require the I/O fencing system.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===system-ping===
===share-client-get===
Returns the name, ID, and version of the system without authentication to support discovery services.
Returns information about the specific Network Share NFS client access rule.


<pre> qs system-ping|sys-ping [--flags=value ] </pre>
<pre> qs share-client-get|shr-cget --share=value [--filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===system-platform-event===
===share-client-list===
Signal the service with an event.
Returns a list of NFS clients access rules for the specified Network Share.


<pre> qs system-platform-event|sys-pe --event-type=value --event-message=value [--flags=value ] </pre>
<pre> qs share-client-list|shr-clist --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>event-type</tt> || The class of event that is being signaled.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>event-message</tt> || The message/key of the event to signal.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===system-restart===
===share-client-modify===
Restarts the entire Storage System.
Modifies a NFS client access rule for the specified Network Share.


<pre> qs system-restart|restart --sys-list=value [--flags=value ] </pre>
<pre> qs share-client-modify|shr-cmodify --share=value --filter=value [--rdonly=value ] [--secure=value ] [--async=value ] [--subtree=value ] [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
|-
| &nbsp; || <tt>rdonly</tt> || Allow only read requests for the NFS volume
|-
| &nbsp; || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>async</tt> || Use asynchronous communication between NFS server and client
|}
 
 
===system-shutdown===
Shutdown the Storage System.
 
<pre> qs system-shutdown|shutdown --sys-list=value [--service-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>subtree</tt> || Enables subtree checking
|-
|-
| &nbsp; || <tt>service-only</tt> || Shutdown just the management service and not the system.
| &nbsp; || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===system-signal-manager===
===share-client-remove===
Send signal to named manager module.
Removes NFS client access rule for the specified Network Share.


<pre> qs system-signal-manager|sys-sigmgr --manager-class=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs share-client-remove|shr-cremove --share=value --filter=value [--retain-client-connection=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>manager-class</tt> || The code/identifier of the manager to receive the signal. [alua, blink, ceph, disk, fabric, firewall, gridsync, ha, haconn, hardware, hotspare, infiniband, librato, pool, replication, sharenamespace, smart, stats, targetport]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>filter</tt> || A filter string for the client
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>retain-client-connection</tt> || Retain client connection. Default is false.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===system-upgrade===
===share-clone===
Upgrade to the latest version of the core packages.
Creates a full copy of the specified Network Share to another storage pool.


<pre> qs system-upgrade|upgrade --sys-list=value [--include-kernel=value ] [--distro-upgrade=value ] [--allow-reboot=value ] [--core-only=value ] [--flags=value ] </pre>
<pre> qs share-clone|shr-clone --share=value --pool=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>sys-list</tt> || List of one or more Storage Systems.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>include-kernel</tt> || Include kernel and driver updates (default=false)
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>distro-upgrade</tt> || Perform a distribution upgrade (default=false)
| &nbsp; || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
|-
|-
| &nbsp; || <tt>allow-reboot</tt> || Allow reboots to occur automatically when one is required.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>core-only</tt> || Only upgrade the core Service and WUI/Manager packages.
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===timezone-list===
===share-create===
Lists all the available time zones from the system time zone table.
Creates a new Network Share accessible via NFS v3/v4 and the SMB protocol.


<pre> qs timezone-list|tz-list [--storage-system=value ] [--search-filter=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 ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--reserved=value ] [--vvol-type=value ] [--protocol-end-point=value ] [--is-cloud-container-cache=value ] [--nfs-security-policy=value ] [--parent-share=value ] [--encrypt=value ] [--encryption-key=value ] [--count=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--immutability-mode=value ] [--days-of-immutability=value ] [--small-block-threshold=value ] [--file-quota=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>search-filter</tt> || Filter the results of the time zone list to match the specified search string.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
|}
 
 
===timezone-set===
Sets the time zone for the specified storage appliance.
 
<pre> qs timezone-set|tz-set --timezone=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>timezone</tt> || System time zone, for example 'America/Los_Angeles'
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
|}
 
 
===tunable-get===
Returns the value of a specific tunable for the specified system.
 
<pre> qs tunable-get|sst-get --tunable=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.  If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
|-
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
| &nbsp; || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
|}
 
 
===tunable-list===
Returns a list of all the system performance tuning which can be used to adjust cache and other settings for specific use cases.
 
<pre> qs tunable-list|sst-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>sync</tt> || 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]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|}
 
 
===tunable-profile-apply===
Applies the specified Storage System tuning profile.
 
<pre> qs tunable-profile-apply|sstp-apply --tunable-profile=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>copies</tt> || 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).
|}
 
 
===tunable-profile-create===
Creates a new Storage System tuning profile with the specified list of tunings.
 
<pre> qs tunable-profile-create|sstp-create --name=value --desc=value --tunable=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>share-owner</tt> || Name of the share owner
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
|-
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
| &nbsp; || <tt>permissions</tt> || 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--
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
|-
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
| &nbsp; || <tt>vvol-type</tt> || vvol type for VASA support. Type can be none for no VASA support, protocolEndPoint or subVol. Default is none. [*none, protocol-end-point, subvol-config, subvol-data, subvol-swap]
|-
| &nbsp; || <tt>protocol-end-point</tt> || Protocol Endpoint ID only applies to VVOL based Network Shares and indicates the parent share on which the VVOL should be created.
|-
| &nbsp; || <tt>is-cloud-container-cache</tt> || Indicates if this share is to be used as Cloud Container cache. 'true' if used as a cache.
|-
| &nbsp; || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
|-
| &nbsp; || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
| &nbsp; || <tt>encrypt</tt> || Enables encryption for the specified share.  Network Share level encryption is independent from the encryption setting for the Storage Pool which may be encrypted or unencrypted.  Encryption can only be enabled at the time of storage resource creation.
|-
| &nbsp; || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
|-
| &nbsp; || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
|-
| &nbsp; || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>disable-nfs-hidden-dir-browsing</tt> || Disables NFS snapshot browsing for .zfs folder
|-
| &nbsp; || <tt>immutability-mode</tt> || Enables file immutability/WORM support for the specified share on creation. [append, immutable, *none]
|-
| &nbsp; || <tt>days-of-immutability</tt> || The number of days a new file will be marked as immutable. After the file is old enough, it will be marked mutable at midnight.
|-
| &nbsp; || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev.  Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
| &nbsp; || <tt>file-quota</tt> || Quota on the number of files within the Network Share.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===tunable-profile-delete===
===share-create-alias===
Deletes the specified Storage System tuning profile.
Creates an alias for the specified share.  Aliases have their own separate permissions settings which can be customized and can inherit from it's associated parent share. Aliases can also reference a sub-directory of the parent share.


<pre> qs tunable-profile-delete|sstp-delete --tunable-profile=value [--flags=value ] </pre>
<pre> qs share-create-alias|shr-create-alias --name=value --parent-share=value [--subpath=value ] [--inherit-access=value ] [--desc=value ] [--public=value ] [--active=value ] [--force-create-sub-dir=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
| &nbsp; || <tt>subpath</tt> || Sub-directory within the parent share to associate with this sub-share.  If the directory doesn't exist it will be created automatically and the sub-path can refer to a directory which is nested multiple levels deep.
|-
| &nbsp; || <tt>inherit-access</tt> || Inherit access control settings from the parent share including the NFS access entries and CIFS user/group access entries. [cifs, nfs, *none]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
| &nbsp; || <tt>force-create-sub-dir</tt> || Force creation of sub directory if not present. Without this option existing directory will not be used if present.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===tunable-profile-get===
===share-delete===
Returns information about the specified profile.
Deletes the specified Network Share


<pre> qs tunable-profile-get|sstp-get --tunable-profile=value [--flags=value ] </pre>
<pre> qs share-delete|shr-delete [--share-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
| &nbsp; || <tt>share-list</tt> || A list of one or more Network Shares.
|-
| &nbsp; || <tt>delete-child-snaps-only</tt> || Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>delete-child-snaps-and-parent</tt> || Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
|-
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
| &nbsp; || <tt>dry-run-only</tt> || Dry run will not delete any shares, only returns a list of shares found by the specified search criteria and options
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===tunable-profile-list===
===share-disable===
Returns a list of all the Storage System tuning profiles.
Disables/deactivates the specified Network Share


<pre> qs tunable-profile-list|sstp-list [--flags=value ] </pre>
<pre> qs share-disable|shr-disable --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===tunable-profile-modify===
===share-enable===
Modifies the specified Storage System tuning profile.
Enables/activates the specified Network Share


<pre> qs tunable-profile-modify|sstp-modify --tunable-profile=value [--name=value ] [--desc=value ] [--tunable=value ] [--flags=value ] </pre>
<pre> qs share-enable|shr-enable --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===tunable-set===
===share-file-lock-list===
Sets the value of a specific tunable for the specified system.
Returns a list of all the open files (SMB only) for the specified Network Share.


<pre> qs tunable-set|sst-set --tunable=value [--storage-system=value ] [--tunable-option=value ] [--flags=value ] </pre>
<pre> qs share-file-lock-list|shr-lock-list [--share=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &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>tunable-option</tt> || Options for setting or resetting all tunables for a given need like IOPS, resilvering, and system defaults. [*none, reset]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>


==Storage System Replication Link Management [SYSTEM-LINK]==
===share-get===
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.
Returns information about the specified Network Share.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===replication-link-create===
<pre> qs share-get|shr-get --share=value [--flags=value ] </pre>
Create a new Storage System Replication Link so that Storage Volumes may be replicated between Storage Systems.
 
<pre> qs replication-link-create|rl-create --storage-system=value --remote-system=value --local-ip=value --remote-ip=value [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>remote-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
|}
| &nbsp; || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
 
 
===share-group-quota-add===
Set a group quota for the Network Share
 
<pre> qs share-group-quota-add|shr-group-quota-add --share=value --user-group=value --quota-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
| &nbsp; || <tt>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|-
| &nbsp; || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===share-group-quota-remove===
Remove a group quota for the Network Share
 
<pre> qs share-group-quota-remove|shr-group-quota-remove --share=value --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===replication-link-delete===
===share-health-check===
Delete an existing replication link.
Checks the health/state of the share and recursively checks the health of the associated pool and it's disk devices to see if there are any health issues anywhere in the stack.


<pre> qs replication-link-delete|rl-delete --link=value [--flags=value ] </pre>
<pre> qs share-health-check|shr-check --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replication-link-get===
===share-hold-add===
Get information about the replication link.
Add a hold on a Network Share snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.


<pre> qs replication-link-get|rl-get --link=value [--flags=value ] </pre>
<pre> qs share-hold-add|shr-hld-add --share=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replication-link-list===
===share-hold-remove===
List the existing replication links.
Remove a hold on a Network Share snapshot. Releasing the hold will allow deletion.


<pre> qs replication-link-list|rl-list [--flags=value ] </pre>
<pre> qs share-hold-remove|shr-hld-remove --share=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>hold-tag</tt> || Tag identifying the hold.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===replication-link-modify===
===share-join-domain===
Modify the properties of the replication link.
Joins the specified Active Directory domain/realm.


<pre> qs replication-link-modify|rl-modify --link=value --remote-ip=value [--local-ip=value ] [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
<pre> qs share-join-domain|shr-jdomain --storage-system=value --domain=value --realm=value --kdc=value --ad-admin=value --ad-password=value [--idmap-mode=value ] [--allow-trusted-domains=value ] [--computer-act-ou=value ] [--min-uid=value ] [--max-uid=value ] [--min-def-uid=value ] [--max-def-uid=value ] [--range-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>domain</tt> || The name of the AD domain to have the Storage System join. (DOMAIN)
|-
|-
| &nbsp; || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>realm</tt> || The name of the AD realm that the domain is in. (DOMAIN.COM)
|-
| &nbsp; || <tt>kdc</tt> || The name of the Active Directory server/machine.
|-
| &nbsp; || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
|-
| &nbsp; || <tt>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
|-
| &nbsp; || <tt>idmap-mode</tt> || Specifies the Unix to Active Directory ID mapping mode (idmap config) of rid, autorid, tdb, ad, ad-rfc2307 [ad, ad-rfc2307, autorid, rid, *tdb]
|-
| &nbsp; || <tt>allow-trusted-domains</tt> || Allow discovery of trusted domains (default=false)
|-
| &nbsp; || <tt>computer-act-ou</tt> || Organization Unit to create the computer account in
|-
| &nbsp; || <tt>min-uid</tt> || Min UID in the range
|-
|-
| &nbsp; || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
| &nbsp; || <tt>max-uid</tt> || Max UID in the range
|-
|-
| &nbsp; || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
| &nbsp; || <tt>min-def-uid</tt> || Max UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
|-
|-
| &nbsp; || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
| &nbsp; || <tt>max-def-uid</tt> || Min UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>range-size</tt> || Defines the number of uids/gids available per domain range. Only used in idmap mode 'autorid'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>


==Tag/Object Property Management [TAG]==
===share-key-export===
Feature which allows any object within the Storage System/Grid 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.
Exports all the encryption key information for the specified Network Share into a block that can be used in the future to re-import the keys.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===tag-delete===
<pre> qs share-key-export|shr-key-export --network-share=value --key-file=value [--flags=value ] </pre>
Deletes a specific tag on a specific object.
 
<pre> qs tag-delete|prop-delete --object-id=value --tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|-
| &nbsp; || <tt>tag</tt> || 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.
| &nbsp; || <tt>key-file</tt> || File name to use for the exported pool key block.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===tag-get===
===share-key-import===
Returns information on a specific tag on a specific object.
Import the previously exported encryption keys for a Network Share to the specified Storage System.


<pre> qs tag-get|prop-get --object-id=value --tag=value [--flags=value ] </pre>
<pre> qs share-key-import|shr-key-import --key-file=value --network-share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
| &nbsp; || <tt>key-file</tt> || File which contains the previously exported key block to use for importing.
|-
|-
| &nbsp; || <tt>tag</tt> || 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.
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
|}




===tag-list===
===share-leave-domain===
Lists all the tags for the object with the specified object UUID.
Leaves the current Active Directory domain.


<pre> qs tag-list|prop-list --object-id=value [--flags=value ] </pre>
<pre> qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--preserve-access-entries=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
|}
|-
| &nbsp; || <tt>preserve-access-entries</tt> || When a system is removed from an AD domain all local storage pools will have their AD user access control information scrubbed from all Network Shares unless preserve entries is specified.  (default=true)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}




===tag-set===
===share-list===
Adds a new tag/property to the specified object, use a value of hyphen '-' to clear a previously set value.
Returns a list of all the Network Shares in the system.


<pre> qs tag-set|prop-set --object-id=value --tag=value --value=value [--value-type=value ] [--object-type=value ] [--flags=value ] </pre>
<pre> qs share-list|shr-list [--vasa-support-only=value ] [--include-snapshots=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
| &nbsp; || <tt>vasa-support-only</tt> || VASA support only.
|-
|-
| &nbsp; || <tt>tag</tt> || tag
| &nbsp; || <tt>include-snapshots</tt> || Include snapshots in the list
|-
|-
| &nbsp; || <tt>value</tt> || value
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===share-load-encryption-key===
Load the encryption key of an encrypted network share so that the key is in the available state.
 
<pre> qs share-load-encryption-key|shr-load-key --network-share=value [--encryption-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>value-type</tt> || value-type [float, int, *string, time]
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|-
| &nbsp; || <tt>object-type</tt> || object-type [alert, disk, host, host-group, pool, port, share, task, user, user-group, *volume]
| &nbsp; || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}


</div>
</div>


==Network Interface Management [TARGET-PORT]==
===share-modify===
Commands for configuration, management and monitoring of network ports, teaming/bonding, VLAN configuration and more.
Modifies the properties of the specified Network Share.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===bonded-interface-create===
<pre> qs share-modify|shr-modify --share=value [--name=value ] [--desc=value ] [--active=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--cifs-enable=value ] [--user-access-list=value ] [--group-access-list=value ] [--cifs-options=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--is-active-checkpoint=value ] [--reserved=value ] [--nfs-security-policy=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--small-block-threshold=value ] [--file-quota=value ] [--flags=value ] </pre>
Creates a bonded network interface by bonding/teaming together a group of one or more physical network ports.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>port-list</tt> || List of target ports to be bonded together.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
|-
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
| &nbsp; || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
|-
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
| &nbsp; || <tt>sync</tt> || 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]
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
| &nbsp; || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|}
 
 
===bonded-interface-delete===
Deletes the specified bonded network interface.
 
<pre> qs bonded-interface-delete|bond-delete --port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>copies</tt> || 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).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
|}
|-
 
| &nbsp; || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
 
|-
===fiber-channel-port-disable===
| &nbsp; || <tt>group-access-list</tt> || 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.
Disables the specified fiber channel port.
|-
 
| &nbsp; || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.  If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
<pre> qs fiber-channel-port-disable|fcp-disable --port=value [--flags=value ] </pre>
|-
{| cellspacing='0' cellpadding='5'
| &nbsp; || <tt>share-owner</tt> || Name of the share owner
|-
| &nbsp; || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
|-
| &nbsp; || <tt>permissions</tt> || 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--
|-
| &nbsp; || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
|-
| &nbsp; || <tt>is-active-checkpoint</tt> || Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system.  Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage session.
|-
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
| &nbsp; || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
|-
| &nbsp; || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
|-
| &nbsp; || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
|-
| &nbsp; || <tt>disable-nfs-hidden-dir-browsing</tt> || Disables NFS snapshot browsing for .zfs folder
|-
| &nbsp; || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev.  Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>file-quota</tt> || Quota on the number of files within the Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===fiber-channel-port-enable===
===share-move===
Enables the specified fiber channel port.
Moves the specified Network Share inside an existing Network Share.


<pre> qs fiber-channel-port-enable|fcp-enable --port=value [--flags=value ] </pre>
<pre> qs share-move|sh-move --share=value --new-parent=value [--new-name=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>new-parent</tt> || New parent for the specified nested share
|-
| &nbsp; || <tt>new-name</tt> || New name for the share. If left name, existing name will be used for the move
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===fiber-channel-port-get===
===share-quota-list===
Returns information about the specified fiber channel target port.
Returns the user quotas for the Network Share.


<pre> qs fiber-channel-port-get|fcp-get --port=value [--flags=value ] </pre>
<pre> qs share-quota-list|shr-quota-list --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===fiber-channel-port-list===
===share-restore===
Returns a list of all the fiber channel target ports in the system.
Restores the specified Network Share with the contents of the specified snapshot.


<pre> qs fiber-channel-port-list|fcp-list [--flags=value ] </pre>
<pre> qs share-restore|shr-restore --share=value --share-snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===infiniband-port-get===
===share-rollback===
Returns information about the specified infiniband port.
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.


<pre> qs infiniband-port-get|ibp-get --port=value [--flags=value ] </pre>
<pre> qs share-rollback|shr-rollback --share=value --share-snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===infiniband-port-list===
===share-search===
Returns a list of all the infiniband ports in the system.
Returns a subset of Network Shares matching the given criteria.


<pre> qs infiniband-port-list|ibp-list [--flags=value ] </pre>
<pre> qs share-search|shr-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===network-port-disable===
===share-set-passphrase===
Disables the specified target port.
Sets or changes the encryption passphrase for an encrypted network share.


<pre> qs network-port-disable|np-disable --port=value [--flags=value ] </pre>
<pre> qs share-set-passphrase|shr-set-passphrase --network-share=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
| &nbsp; || <tt>current-passphrase</tt> || Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
|-
| &nbsp; || <tt>new-passphrase</tt> || New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
|}




===network-port-enable===
===share-snapshot===
Enables the specified target port.
Creates and instant space efficient snapshot of the specified Network Share (requires Advanced Storage Pool)


<pre> qs network-port-enable|np-enable --port=value [--flags=value ] </pre>
<pre> qs share-snapshot|shr-snap --share=value [--name=value ] [--desc=value ] [--active=value ] [--lazy-clone=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
| &nbsp; || <tt>lazy-clone</tt> || 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.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===network-port-get===
===share-unload-encryption-key===
Returns information about the specified target port.
Unload the encryption key of an encrypted network share so that the key is in the unavailable state.


<pre> qs network-port-get|np-get --port=value [--flags=value ] </pre>
<pre> qs share-unload-encryption-key|shr-unload-key --network-share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===network-port-list===
===share-user-quota-add===
Returns a list of all the target ports in the system.
Set a user quota for the Network Share


<pre> qs network-port-list|np-list [--flags=value ] </pre>
<pre> qs share-user-quota-add|shr-user-quota-add --share=value --user=value --quota-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
| &nbsp; || <tt>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===network-port-modify===
===share-user-quota-remove===
Modifies target port settings including IP address, gateway, mtu, etc.
Remove a user quota for the Network Share.


<pre> qs network-port-modify|np-modify --port=value [--port-type=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--auto-tune=value ] [--desc=value ] [--float-list=value ] [--bond-mode=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--protocol-allow=value ] [--protocol-allow-reset=value ] [--flags=value ] </pre>
<pre> qs share-user-quota-remove|shr-user-quota-remove --share=value --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of a target port, or 'all' to modify all ports.
| &nbsp; || <tt>share</tt> || Name or ID of a Network Share.
|-
|-
| &nbsp; || <tt>port-type</tt> || Port configuration type. (static, dhcp)
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
</div>
</div>
 
==Site Cluster Resource Management [SITE]==
Site Clusters manage virtual interfaces to which can float between cluster members to ensure high-availability to Storage Pools and other resources.  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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===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.
 
<pre> qs cluster-ring-create|cr-create --site=value --member-addresses=value [--ring=value ] [--bind-address=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
| &nbsp; || <tt>member-addresses</tt> || IP addresses, one from each appliance, used to form a new cluster ring for cluster communication activities.
|-
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
| &nbsp; || <tt>ring</tt> || Unique cluster ring number starting with 0 for the first ring in the site.
|-
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
| &nbsp; || <tt>bind-address</tt> || The bind address represents the network on which cluster communication is allowed for a specific ring.
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
|-
| &nbsp; || <tt>auto-tune</tt> || Enables automatic configuration of the RX/TX buffers to maximize throughput for large block I/O and replication.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>float-list</tt> || 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.
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
|-
| &nbsp; || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, iscsi, *nfs, restapi, smb]
|-
| &nbsp; || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
| &nbsp; || <tt>protocol-allow</tt> || The protocol that needs to be allowed specified as 'nfs,smb'. prepend with tilde (~) to remove from the allow list. Protocols already allowed will be retained. To reset the allow list, use 'protocol-allow-reset' argument. [ceph, iscsi, *nfs, restapi, smb]
|-
| &nbsp; || <tt>protocol-allow-reset</tt> || Reset the protocol allow list. Any values provided in the argument protocol-allow will be ignored.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===network-port-rescan===
===cluster-ring-delete===
Discovers new target ports and/or any manual modifications made to the configuration of the target ports.
Deletes the specified cluster ring configuration.


<pre> qs network-port-rescan|np-rescan [--storage-system=value ] [--flags=value ] </pre>
<pre> qs cluster-ring-delete|cr-delete --cluster-ring=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>cluster-ring</tt> || 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
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===network-port-restart===
===cluster-ring-get===
Restarts the specified target port.
Returns the details about a specific cluster ring.  A ring represents a communication channel for cluster heartbeat communication. Ideal cluster configurations have two rings.


<pre> qs network-port-restart|np-restart --port=value [--flags=value ] </pre>
<pre> qs cluster-ring-get|cr-get --cluster-ring=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
| &nbsp; || <tt>cluster-ring</tt> || 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
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===provider-app-get===
===cluster-ring-list===
Get the registered provider information.
Returns a list of the cluster ring configurations.
 
<pre> qs cluster-ring-list|cr-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===cluster-ring-member-get===
Returns information about the specified cluster ring member.
 
<pre> qs cluster-ring-member-get|crm-get --cluster-ring-member=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>cluster-ring-member</tt> || A cluster-ring-member represents a physical interface on a appliance used for cluster communication.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===cluster-ring-member-list===
Returns a list of all the cluster ring members of the site.
 
<pre> qs cluster-ring-member-list|crm-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===site-cluster-add-nodes===
Add the specified Storage Systems to the site cluster.
 
<pre> qs site-cluster-add-nodes|sc-add-nodes --site=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===site-cluster-assoc-get===
Returns detailed information about the specified site association.
 
<pre> qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system</tt> || The system with the site association.
|-
| &nbsp; || <tt>site-assoc</tt> || A site association is a link between a system and a site.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===site-cluster-assoc-list===
Returns a list of all the configured site association.
 
<pre> qs site-cluster-assoc-list|sca-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===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.
 
<pre> qs site-cluster-create|sc-create --name=value --system-ip-list=value [--desc=value ] [--location=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>system-ip-list</tt> || List of the IP addresses, one from each system to be selected to form a new Site Cluster.  The selected IPs will be used to form the initial heart-beat ring and must be from the same network.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===site-cluster-delete===
Deletes the specified site configuration.
 
<pre> qs site-cluster-delete|sc-delete --site=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===site-cluster-get===
Returns detailed information about the specified site.
 
<pre> qs site-cluster-get|sc-get --site=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===site-cluster-list===
Returns a list of all the configured sites.
 
<pre> qs site-cluster-list|sc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===site-cluster-modify===
Modifies the configuration settings of a site like it's name, location or description.
 
<pre> qs site-cluster-modify|sc-modify --site=value [--name=value ] [--desc=value ] [--location=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
 
 
===site-cluster-remove-nodes===
Remove the specified Storage Systems from the site cluster.
 
<pre> qs site-cluster-remove-nodes|sc-remove-nodes --site=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===site-cluster-rescan===
Rescans the Site Cluster configuration for a given Site Cluster.
 
<pre> qs site-cluster-rescan|sc-rescan [--site=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===site-cluster-restart-services===
Restarts the corosync/pacemaker services on the specified appliance.
 
<pre> qs site-cluster-restart-services|sc-restart --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===site-cluster-toggle-maintenance-mode===
Toggles maintenance mode for the given Site Cluster. Warning: when Site Cluster is in maintenance mode, all Site Cluster Vifs will become unmanaged.
 
<pre> qs site-cluster-toggle-maintenance-mode|sc-tog-mmode --site=value --enable-maintenance-mode=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>enable-maintenance-mode</tt> || If true, puts the Site Cluster into maintenance mode. If false, brings Site Cluster our of maintenance mode.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===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.
 
<pre> qs site-vif-create|svr-create --site=value --parent-port=value --ip-address=value [--netmask=value ] [--mac-address=value ] [--description=value ] [--location-config=value ] [--usecase-obj-id=value ] [--vif-use-case=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--mtu=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>site</tt> || A site is a group of appliances in a location.
|-
| &nbsp; || <tt>parent-port</tt> || 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.
|-
| &nbsp; || <tt>ip-address</tt> || IP address of the form x.x.x.x such as 10.0.0.10
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>mac-address</tt> || MAC Address
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
|-
| &nbsp; || <tt>usecase-obj-id</tt> || Name or ID of the usecase object associated with this vif (ie, HA Group for a HA Vif, Ceph Cluster for a File pool Vif, etc)
|-
| &nbsp; || <tt>vif-use-case</tt> || Specifies the use case in which the new vif shall be used. [grid-primary, *ha, other, s3proxy, scaleout-block, scaleout-file, scaleout-obj]
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
|-
| &nbsp; || <tt>convert-vif</tt> || Convert existing local virtual ip address into an HA site VIF.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===site-vif-delete===
Deletes the virtual interface site resource and it's associated configuration information from the cluster configuration.
 
<pre> qs site-vif-delete|svr-delete --vif-resource=value [--convert-to-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>convert-to-vif</tt> || Convert HA site VIF resource into a local virtual ip address.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===site-vif-get===
Returns the details about the specified virtual interface cluster resource in a site.
 
<pre> qs site-vif-get|svr-get --vif-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===site-vif-list===
Returns a list of all the virtual interface site resources.
 
<pre> qs site-vif-list|svr-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===site-vif-location-constraint-get===
Returns a specific location constraint for a Site Vif Resource given the Site Vif Resource and the associated Storage System Node.
 
<pre> qs site-vif-location-constraint-get|sv-lc-get --vif-resource=value --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===site-vif-location-constraint-list===
Returns a list of all the location constraints for all Site Vif Resources.
 
<pre> qs site-vif-location-constraint-list|sv-lc-list [--vif-resource=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===site-vif-modify===
Updates a given Site Vif's use case, use case object, and/or location constraints.
 
<pre> qs site-vif-modify|svr-modify --vif-resource=value [--description=value ] [--location-config=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===site-vif-move===
Moves the virtual interface resource from the current system it is attached to the specified Storage System.  The target Storage System must be a member of the site cluster configuration.
 
<pre> qs site-vif-move|svr-move --vif-resource=value --move-to-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>vif-resource</tt> || A site virtual interface resource.
|-
| &nbsp; || <tt>move-to-system</tt> || Destination system to move the virtual interface over to.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
</div>
</div>
 
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===storage-tier-create===
Creates a new Storage Tier comprised of the specified storage pools
 
<pre> qs storage-tier-create|st-create --name=value --pool-list=value [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
|-
| &nbsp; || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
|-
| &nbsp; || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===storage-tier-delete===
Deletes the specified Storage Tier (pools are not deleted).
 
<pre> qs storage-tier-delete|st-delete --tier=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===storage-tier-get===
Returns information about a specific Storage Tier.
 
<pre> qs storage-tier-get|st-get --tier=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===storage-tier-list===
Returns a list of all the Storage Tiers.
 
<pre> qs storage-tier-list|st-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===storage-tier-modify===
Modifies the name, description or other property of the specified storage tier.
 
<pre> qs storage-tier-modify|st-modify --tier=value [--name=value ] [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
|-
| &nbsp; || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
|-
| &nbsp; || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|}
 
 
===storage-tier-pool-add===
Adds one or more pools to the specified storage tier.
 
<pre> qs storage-tier-pool-add|stp-add --tier=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===storage-tier-pool-remove===
Removes one or more pools from the specified storage tier.
 
<pre> qs storage-tier-pool-remove|stp-remove --tier=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
| &nbsp; || <tt>pool-list</tt> || List of storage pools.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
</div>
</div>
 
==Software Controller / iSCSI SAN Adapter [SWC]==
Storage Systems may connect to other SANs via iSCSI via the additon of one or more iSCSI Software Adapters/Controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===sw-controller-add===
Adds an iSCSI or NVMe SAN adapter for connecting to the specified iSCSI or NVMe SAN.
 
<pre> qs sw-controller-add|swc-add --storage-system=value --name=value --ip-address=value --sw-controller-type=value [--desc=value ] [--port=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>port</tt> || Port number for the Software Controller portal, defaults to 3260 if iSCSI, or 4420 if NVMe.
|-
| &nbsp; || <tt>sw-controller-type</tt> || Protocol type of Software Controller. [*iscsi, nvme-rdma, nvme-tcp]
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===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 --system-list=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>volume-list</tt> || List of one or more Storage Volumes.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===sw-controller-get===
Gets detailed information about a specific software SAN controller.
 
<pre> qs sw-controller-get|swc-get --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===sw-controller-list===
Returns a list of all the configured software SAN adapter/controllers (iSCSI, etc).
 
<pre> qs sw-controller-list|swc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===sw-controller-remove===
Removes the specified iSCSI or NVMe SAN adapter
 
<pre> qs sw-controller-remove|swc-remove --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===sw-controller-scan===
Scans the specified iSCSI/NVMe SAN adapter for iSCSI/NVMe targets.
 
<pre> qs sw-controller-scan|swc-scan --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===sw-controller-target===
Returns the specified software controller target.
 
<pre> qs sw-controller-target|swc-target --target=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>target</tt> || The software controller target to operate against
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===sw-controller-target-list===
Returns a list of all the discovered software controller targets.
 
<pre> qs sw-controller-target-list|swc-target-list [--sw-controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===sw-controller-target-login===
Logs into the specified targets on the specified iSCSI SAN adapter.
 
<pre> qs sw-controller-target-login|swc-target-login --sw-controller=value --target-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>target-list</tt> || The list of targets for the software controller to operate against
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===sw-controller-target-logout===
Logs out of the specified targets on the specified iSCSI SAN adapter.
 
<pre> qs sw-controller-target-logout|swc-target-logout --sw-controller=value --target-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>target-list</tt> || The list of targets for the software controller to operate against
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
 
 
===sw-disk-session===
Returns the specified software disk session.
 
<pre> qs sw-disk-session|swc-session --session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>session</tt> || The software disk session to operate against
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===sw-disk-session-list===
Returns a list of all software disk sessions.
 
<pre> qs sw-disk-session-list|swc-session-list [--sw-controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
</div>
</div>
 
==Storage System Management [SYSTEM]==
Commands for managing all the appliance centric settings including NTP, DNS servers, hostname, ARP policies, system restart, shutdown and more.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===enter-system-maintenance===
Set the Storage System(s) in Maintenance mode.
 
<pre> qs enter-system-maintenance|en-maint --system-list=value [--enter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>enter</tt> || Flags to be passed to set one or more subsystem in the Storage System(s) in Maintenance Mode. [*all, ceph, corosync]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===exit-system-maintenance===
Get the Storage System(s) out of Maintenance mode.
 
<pre> qs exit-system-maintenance|ex-maint --system-list=value [--exit=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>exit</tt> || Flags to be passed to move one or more subsystem in the Storage System(s) out of Maintenance Mode. [*all, ceph, corosync]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===system-beacon===
Activates system LED beacon and produces an audible beep pattern for the specified duration to help physically identify a given Storage System within the environment.
 
<pre> qs system-beacon|sys-beep [--duration-sec=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>duration-sec</tt> || Total time duration in seconds to sustain the system audible beep pattern.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===system-get===
Get general information about the Storage System.
 
<pre> qs system-get|sys-get [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===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.
 
<pre> qs system-list|sys-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===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.
 
<pre> qs system-metadata-recovery-point-list|smrp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===system-modify===
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 ] [--enclosure-layout=value ] [--domain-suffix=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--multipath-autoconfig=value ] [--hw-auto-maintenance=value ] [--log-collection=value ] [--eth-naming=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--disable-io-fencing=value ] [--wwn-emulation=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>name</tt> || Storage system host name may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
| &nbsp; || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
|-
| &nbsp; || <tt>domain-suffix</tt> || The domain name suffix for your network such as example.com
|-
| &nbsp; || <tt>search</tt> || The default domain search suffix for your network such as example.com
|-
| &nbsp; || <tt>arp-filter-mode</tt> || ARP filtering should be enabled when you have more than one network card on the same network. [*auto, disabled, enabled]
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
|-
| &nbsp; || <tt>ext-hostname</tt> || Specifies the external hostname for the system.  This is useful for creating grids of systems in the cloud like in Amazon's EC2.
|-
| &nbsp; || <tt>grid-port</tt> || Designated port for grid communication
|-
| &nbsp; || <tt>ntp-servers</tt> || Comma delimited list of NTP servers to assign to the appliance.
|-
| &nbsp; || <tt>dns-servers</tt> || Comma delimited list of DNS servers to assign to the appliance.
|-
| &nbsp; || <tt>multipath-autoconfig</tt> || When enabled multipathing is automatically configured for devices that support it. [disabled, enabled]
|-
| &nbsp; || <tt>hw-auto-maintenance</tt> || Flags to be passed to set one or more automatic repair modes in the Storage System's storage resources. [*none, osd, pool]
|-
| &nbsp; || <tt>log-collection</tt> || When enabled logs are sent periodically for automatic analysis. [biweekly, monthly, never, weekly]
|-
| &nbsp; || <tt>eth-naming</tt> || Applies either Predictable (Predictable Network Interface Naming/PNIN) port naming convention (ensN, enoN, enpN) or Unified (ethN) port naming convention.  Unified (ethN) based naming is the preferred mode as it applies a consistent naming across systems which is needed for highly available cluster VIF management. [*nochange, predictable, unified]
|-
| &nbsp; || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
| &nbsp; || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
| &nbsp; || <tt>disable-io-fencing</tt> || Disables all I/O fencing operations on the system for all media devices. This should only be used on systems used in scale-out configurations and not scale-up HA pool configurations which require the I/O fencing system.
|-
| &nbsp; || <tt>wwn-emulation</tt> || Enables FC WWN emulation and device naming mode to emulate 3rd party SANs. [ibm_storwize, *none, osnexus_ieee, pure_flasharray]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===system-ping===
Returns the name, ID, and version of the system without authentication to support discovery services.
 
<pre> qs system-ping|sys-ping [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===system-platform-event===
Signal the service with an event.
 
<pre> qs system-platform-event|sys-pe --event-type=value --event-message=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>event-type</tt> || The class of event that is being signaled.
|-
| &nbsp; || <tt>event-message</tt> || The message/key of the event to signal.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===system-restart===
Restarts the entire Storage System.
 
<pre> qs system-restart|restart --system-list=value [--yes-i-really-mean-it=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>yes-i-really-mean-it</tt> || Confirms that user is sure they want to execute operation
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===system-shutdown===
Shutdown the Storage System.
 
<pre> qs system-shutdown|shutdown --system-list=value [--service-only=value ] [--yes-i-really-mean-it=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>service-only</tt> || Shutdown just the management service and not the system.
|-
| &nbsp; || <tt>yes-i-really-mean-it</tt> || Confirms that user is sure they want to execute operation
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===system-signal-manager===
Send signal to named manager module.
 
<pre> qs system-signal-manager|sys-sigmgr --manager-class=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>manager-class</tt> || The code/identifier of the manager to receive the signal. [alua, blink, ceph, disk, fabric, firewall, gridsync, ha, haconn, hardware, hotspare, infiniband, pool, replication, sed, sharenamespace, smart, stats, targetport]
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===system-upgrade===
Upgrade to the latest version of the core packages.
 
<pre> qs system-upgrade|upgrade [--system-list=value ] [--include-kernel=value ] [--distro-upgrade=value ] [--allow-reboot=value ] [--core-only=value ] [--ceph-upgrade=value ] [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>system-list</tt> || List of one or more Storage Systems.
|-
| &nbsp; || <tt>include-kernel</tt> || Include kernel and driver updates (default=false)
|-
| &nbsp; || <tt>distro-upgrade</tt> || Perform a distribution upgrade (default=false)
|-
| &nbsp; || <tt>allow-reboot</tt> || Allow reboots to occur automatically when one is required.
|-
| &nbsp; || <tt>core-only</tt> || Only upgrade the core Service and WUI/Manager packages.
|-
| &nbsp; || <tt>ceph-upgrade</tt> || Set this option to upgrade Ceph daemons for the given cluster members.
|-
| &nbsp; || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===timezone-list===
Lists all the available time zones from the system time zone table.
 
<pre> qs timezone-list|tz-list [--storage-system=value ] [--search-filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>search-filter</tt> || Filter the results of the time zone list to match the specified search string.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===timezone-set===
Sets the time zone for the specified storage appliance.
 
<pre> qs timezone-set|tz-set --timezone=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>timezone</tt> || System time zone, for example 'America/Los_Angeles'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-get===
Returns the value of a specific tunable for the specified system.
 
<pre> qs tunable-get|sst-get --tunable=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===tunable-list===
Returns a list of all the system performance tuning which can be used to adjust cache and other settings for specific use cases.
 
<pre> qs tunable-list|sst-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-profile-apply===
Applies the specified Storage System tuning profile.
 
<pre> qs tunable-profile-apply|sstp-apply --tunable-profile=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-profile-create===
Creates a new Storage System tuning profile with the specified list of tunings.
 
<pre> qs tunable-profile-create|sstp-create --name=value --desc=value --tunable=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-profile-delete===
Deletes the specified Storage System tuning profile.
 
<pre> qs tunable-profile-delete|sstp-delete --tunable-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-profile-get===
Returns information about the specified profile.
 
<pre> qs tunable-profile-get|sstp-get --tunable-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===tunable-profile-list===
Returns a list of all the Storage System tuning profiles.
 
<pre> qs tunable-profile-list|sstp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-profile-modify===
Modifies the specified Storage System tuning profile.
 
<pre> qs tunable-profile-modify|sstp-modify --tunable-profile=value [--name=value ] [--desc=value ] [--tunable=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tunable-set===
Sets the value of a specific tunable for the specified system.
 
<pre> qs tunable-set|sst-set --tunable=value [--storage-system=value ] [--tunable-option=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>tunable-option</tt> || Options for setting or resetting all tunables for a given need like IOPS, resilvering, and system defaults. [*none, reset]
|-
| &nbsp; || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings.  When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
</div>
</div>
 
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===replication-link-create===
Create a new Storage System Replication Link so that Storage Volumes may be replicated between Storage Systems.
 
<pre> qs replication-link-create|rl-create --storage-system=value --remote-system=value --local-ip=value --remote-ip=value [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>remote-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
|-
| &nbsp; || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
|-
| &nbsp; || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===replication-link-delete===
Delete an existing replication link.
 
<pre> qs replication-link-delete|rl-delete --link=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===replication-link-get===
Get information about the replication link.
 
<pre> qs replication-link-get|rl-get --link=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===replication-link-list===
List the existing replication links.
 
<pre> qs replication-link-list|rl-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===replication-link-modify===
Modify the properties of the replication link.
 
<pre> qs replication-link-modify|rl-modify --link=value --remote-ip=value [--local-ip=value ] [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>link</tt> || Storage system link ID or name.
|-
| &nbsp; || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
|-
| &nbsp; || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
|-
| &nbsp; || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
</div>
</div>
 
==Tag/Object Property Management [TAG]==
Feature which allows any object within the Storage System/Grid 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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===tag-delete===
Deletes a specific tag on a specific object.
 
<pre> qs tag-delete|prop-delete --object-id=value --tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
| &nbsp; || <tt>tag</tt> || 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.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tag-get===
Returns information on a specific tag on a specific object.
 
<pre> qs tag-get|prop-get --object-id=value --tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
| &nbsp; || <tt>tag</tt> || 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.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tag-list===
Lists all the tags for the object with the specified object UUID.
 
<pre> qs tag-list|prop-list --object-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===tag-set===
Adds a new tag/property to the specified object, use a value of hyphen '-' to clear a previously set value.
 
<pre> qs tag-set|prop-set --object-id=value --tag=value --value=value [--value-type=value ] [--object-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
| &nbsp; || <tt>tag</tt> || tag
|-
| &nbsp; || <tt>value</tt> || value
|-
| &nbsp; || <tt>value-type</tt> || value-type [float, int, *string, time]
|-
| &nbsp; || <tt>object-type</tt> || object-type [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
</div>
</div>
 
==Network Interface Management [TARGET-PORT]==
Commands for configuration, management and monitoring of network ports, teaming/bonding, VLAN configuration and more.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===bonded-interface-create===
Creates a bonded network interface by bonding/teaming together a group of one or more physical network ports.
 
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>port-list</tt> || List of target ports to be bonded together.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===bonded-interface-delete===
Deletes the specified bonded network interface.
 
<pre> qs bonded-interface-delete|bond-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
 
 
===client-connection-list===
Lists all active client connections to the specified system.
 
<pre> qs client-connection-list|ccon-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===fiber-channel-port-disable===
Disables the specified fiber channel port.
 
<pre> qs fiber-channel-port-disable|fcp-disable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===fiber-channel-port-enable===
Enables the specified fiber channel port.
 
<pre> qs fiber-channel-port-enable|fcp-enable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===fiber-channel-port-get===
Returns information about the specified fiber channel target port.
 
<pre> qs fiber-channel-port-get|fcp-get --port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
 
 
===fiber-channel-port-issuelip===
Sends a FC LIP command the specified fiber channel port to force a rediscovery of LUNs / Storage Volumes.
 
<pre> qs fiber-channel-port-issuelip|fcp-issuelip --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===fiber-channel-port-list===
Returns a list of all the fiber channel target ports in the system.
 
<pre> qs fiber-channel-port-list|fcp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===infiniband-port-get===
Returns information about the specified infiniband port.
 
<pre> qs infiniband-port-get|ibp-get --port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
 
 
===infiniband-port-list===
Returns a list of all the infiniband ports in the system.
 
<pre> qs infiniband-port-list|ibp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===network-port-disable===
Disables the specified target port.
 
<pre> qs network-port-disable|np-disable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===network-port-enable===
Enables the specified target port.
 
<pre> qs network-port-enable|np-enable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===network-port-get===
Returns information about the specified target port.
 
<pre> qs network-port-get|np-get --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}
 
 
===network-port-list===
Returns a list of all the target ports in the system.
 
<pre> qs network-port-list|np-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 
 
===network-port-modify===
Modifies target port settings including IP address, gateway, mtu, etc.
 
<pre> qs network-port-modify|np-modify --port=value [--port-type=value ] [--storage-system=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--lossless-networking-enabled=value ] [--auto-tune=value ] [--desc=value ] [--bond-mode=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--protocol-allow=value ] [--protocol-allow-reset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of a target port, or 'all' to modify all ports.
|-
| &nbsp; || <tt>port-type</tt> || Port configuration type. (static, dhcp)
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
| &nbsp; || <tt>nvmeof-enable</tt> || Enables or disables NVMEoF TCP access to the specified port(s).
|-
| &nbsp; || <tt>lossless-networking-enabled</tt> || Enables or disables lossless networking for Melanox ports.
|-
| &nbsp; || <tt>auto-tune</tt> || Enables automatic configuration of the RX/TX buffers to maximize throughput for large block I/O and replication.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>bond-mode</tt> || 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
|-
| &nbsp; || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
| &nbsp; || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
| &nbsp; || <tt>protocol-allow</tt> || The protocol that needs to be allowed specified as 'nfs,smb'. prepend with tilde (~) to remove from the allow list. Protocols already allowed will be retained. To reset the allow list, use 'protocol-allow-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
| &nbsp; || <tt>protocol-allow-reset</tt> || Reset the protocol allow list. Any values provided in the argument protocol-allow will be ignored.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===network-port-rename===
Creates a systemd link file to rename target port.
 
<pre> qs network-port-rename|np-rename --port=value --name=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>name</tt> || New name to assign to target port. It is suggested to have a static network management port with naming prefix 'mgmt'. Avoid using naming prefix 'eth' as it may cause naming conflicts with kernel drivers. Network interfaces are typically enumerated from a 0 index e.g. eno[0,1,2,...]
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===network-port-rescan===
Discovers new target ports and/or any manual modifications made to the configuration of the target ports.
 
<pre> qs network-port-rescan|np-rescan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===network-port-restart===
Restarts the specified target port.
 
<pre> qs network-port-restart|np-restart --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or MAC address of the target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===provider-app-get===
Get the registered provider information.
 
<pre> qs provider-app-get|prov-app-get --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
|}
 
 
===provider-app-list===
List the registered providers.
 
<pre> qs provider-app-list|prov-app-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===provider-app-register===
Register a provider.
 
<pre> qs provider-app-register|prov-app-register --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===provider-app-unregister===
Unregister a provider.
 
<pre> qs provider-app-unregister|prov-app-unregister [--provider-app=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>provider-app</tt> || Provider to unregister.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===service-firewall-definition-list===
List the firewall definitions for the services
 
<pre> qs service-firewall-definition-list|src-firewall-df-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
 
 
===static-route-create===
Creates a new network static route for connecting to other networks.
 
<pre> qs static-route-create|sr-create --port=value --destination-ip-address=value --destination-netmask=value --gateway-ip-address=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
| &nbsp; || <tt>destination-ip-address</tt> || Destination IP address for the static route.
|-
| &nbsp; || <tt>destination-netmask</tt> || Destination subnet mask for the static route.
|-
| &nbsp; || <tt>gateway-ip-address</tt> || Gateway IP address for the static route
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===static-route-delete===
Deletes the specified static route identified by its UUID.
 
<pre> qs static-route-delete|sr-delete --route-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>route-id</tt> || UUID of a static route object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===static-route-get===
Returns information on a specific static route.
 
<pre> qs static-route-get|sr-get --route-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>route-id</tt> || UUID of a static route object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
 
 
===static-route-list===
Returns a list of all the static routes.
 
<pre> qs static-route-list|sr-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}


<pre> qs provider-app-get|prov-app-get --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, sftp, swift, wasabi-s3]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
|}


===storage-system-capabilities-list===
List the Storage System capabilities.


===provider-app-list===
<pre> qs storage-system-capabilities-list|sys-capabilities-list [--flags=value ] </pre>
List the registered providers.
 
<pre> qs provider-app-list|prov-app-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===provider-app-register===
===virtual-interface-create===
Register a provider.
Creates a new virtual network interface which is linked to a physical network port.


<pre> qs provider-app-register|prov-app-register --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs virtual-interface-create|vif-create --parent-port=value --ip-address=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|-
| &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>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, sftp, swift, wasabi-s3]
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===provider-app-unregister===
===virtual-interface-delete===
Unregister a provider.
Deletes the specified virtual network interface.


<pre> qs provider-app-unregister|prov-app-unregister [--provider-app=value ] [--flags=value ] </pre>
<pre> qs virtual-interface-delete|vif-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>provider-app</tt> || Provider to unregister.
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|}
 
 
===service-firewall-definition-list===
List the firewall definitions for the services
 
<pre> qs service-firewall-definition-list|src-firewall-df-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===static-route-create===
===vlan-interface-create===
Creates a new network static route for connecting to other networks.
Creates a new VLAN interface on the specified physical port.


<pre> qs static-route-create|sr-create --port=value --destination-ip-address=value --destination-netmask=value --gateway-ip-address=value [--storage-system=value ] [--flags=value ] </pre>
<pre> 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 ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
|-
|-
| &nbsp; || <tt>destination-ip-address</tt> || Destination IP address for the static route.
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|-
| &nbsp; || <tt>destination-netmask</tt> || Destination subnet mask for the static route.
| &nbsp; || <tt>vlan-id</tt> || VLAN ID (typically 1-255)
|-
| &nbsp; || <tt>gateway-ip-address</tt> || Gateway IP address for the static route
|-
|-
| &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>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>vlan-qos</tt> || 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.
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|}
|}




===static-route-delete===
===vlan-interface-delete===
Deletes the specified static route identified by its UUID.
Deletes the specified VLAN interface.


<pre> qs static-route-delete|sr-delete --route-id=value [--flags=value ] </pre>
<pre> qs vlan-interface-delete|vlan-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>route-id</tt> || UUID of a static route object.
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===static-route-get===
===task-cancel===
Returns information on a specific static route.
Cancels the specified task that is in the queue or is running.


<pre> qs static-route-get|sr-get --route-id=value [--flags=value ] </pre>
<pre> qs task-cancel|t-cancel --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>route-id</tt> || UUID of a static route object.
| &nbsp; || <tt>task</tt> || ID of a task.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===static-route-list===
===task-clear-all===
Returns a list of all the static routes.
Clears all the completed and/or failed tasks from the task log so that only the running and queued tasks (if any) remain.


<pre> qs static-route-list|sr-list [--flags=value ] </pre>
<pre> qs task-clear-all|t-clear-all [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===storage-system-capabilities-list===
===task-get===
List the Storage System capabilities.
Returns information about the specified task.


<pre> qs storage-system-capabilities-list|sys-capabilities-list [--flags=value ] </pre>
<pre> qs task-get|t-get --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>task</tt> || ID of a task.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
|}




===virtual-interface-create===
===task-list===
Creates a new virtual network interface which is linked to a physical network port.
Returns a list of all the Tasks including active, completed, and failed tasks. Whenever you run a command in the Storage Grid it is queued in the internal Task Manager and then executed automatically once the necessary resource locks are acquired.


<pre> 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 ] </pre>
<pre> qs task-list|t-list [--filtered=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
| &nbsp; || <tt>filtered</tt> || Returns just the 'value' most recently created.
|-
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
|}
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
 
 
===task-lock-list===
Returns a list of internal task object locks for the specified storage system.
 
<pre> qs task-lock-list|tl-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>float-list</tt> || 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.
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===virtual-interface-delete===
===task-lock-release===
Deletes the specified virtual network interface.
Releases the specified internal task object locks on the specified storage system (internal support use only, --force flag required).


<pre> qs virtual-interface-delete|vif-delete --port=value [--flags=value ] </pre>
<pre> qs task-lock-release|tl-release --task=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>task</tt> || ID of a task.
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
|}
|}




===virtual-interface-move===
===task-proceed===
Moves the specified virtual network interface to a different physical network port.
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.


<pre> qs virtual-interface-move|vif-move --vif=value --port=value [--flags=value ] </pre>
<pre> qs task-proceed|t-proceed --task=value [--wait-for-signal=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>vif</tt> || Name of unique ID (GUID) for the virtual interface.
| &nbsp; || <tt>task</tt> || ID of a task.
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>wait-for-signal</tt> || 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'.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
==Trace Level Management [TRACE-LEVEL]==
Debugging facility used to increase the amount of information sent to the /var/log/qs_service.log
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===vlan-interface-create===
===event-pulse===
Creates a new VLAN interface on the specified physical port.
Updates object timestamps of the specified type for the specified system to induce event traffic in the grid for testing purposes.


<pre> 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 ] </pre>
<pre> qs event-pulse|e-pulse --object-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
| &nbsp; || <tt>object-type</tt> || Type of the object to associate the tag with. [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
|-
| &nbsp; || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
| &nbsp; || <tt>vlan-id</tt> || VLAN ID (typically 1-255)
|-
|-
| &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>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>gateway</tt> || IP address of the network gateway
|-
| &nbsp; || <tt>vlan-qos</tt> || 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.
|-
| &nbsp; || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
|}
|}




===vlan-interface-delete===
===trace-level-get===
Deletes the specified VLAN interface.
Get the current trace level that is being used for logging.


<pre> qs vlan-interface-delete|vlan-delete --port=value [--flags=value ] </pre>
<pre> qs trace-level-get|tl-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>port</tt> || Name or unique ID of a network port/target port.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


</div>
</div>


==Task Management [TASK]==
===trace-level-modify===
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.
Modify the current parameters used for logging.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===task-cancel===
<pre> qs trace-level-modify|tl-modify [--trace-level=value ] [--stdout=value ] [--trace-filter=value ] [--trace-options=value ] [--event-verbose-filter=value ] [--flags=value ] </pre>
Cancels the specified task that is in the queue or is running.
 
<pre> qs task-cancel|t-cancel --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>task</tt> || ID of a task.
| &nbsp; || <tt>trace-level</tt> || This is the trace level you would like the system to use for logging. [always, critical, debug, debug2, *error, info, verbose, warning]
|-
| &nbsp; || <tt>stdout</tt> || Whether or not the traces should also be logged to stdout
|-
| &nbsp; || <tt>trace-filter</tt> || Specific classes that you would like to have elevated trace levels. Comma-delimited list of classes, containing optional colon-delimited function names. For example: 'service/osn_foo_util.cpp,service/osn_service_bar.cpp:func1:func2'
|-
| &nbsp; || <tt>trace-options</tt> || Specific options for tracing [enable-cpuinfo,disable-cpuinfo,enable-meminfo,disable-meminfo,enable-calllog,disable-calllog,enable-eventlog,disable-eventlog,enable-execlog,disable-execlog,executing,enable-delta-ObjectType,disable-delta-ObjectType]
|-
| &nbsp; || <tt>event-verbose-filter</tt> || Specific object types that you would like to have verbose event logging levels. Comma-delimited list of object types, containing optional colon-delimited event types. For example: 'HwEnclosure:modify:add'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===task-clear-all===
==User Management [USER]==
Clears all the completed and/or failed tasks from the task log so that only the running and queued tasks (if any) remain.
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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


<pre> qs task-clear-all|t-clear-all [--flags=value ] </pre>
===user-add===
{| cellspacing='0' cellpadding='5'
Adds a new management User account to the Storage System/Grid.  A matching console level account is created on all grid nodes but by default SSH access is blocked. Rather, management accounts enable the use of qs CLI commands and web management interface access as per the limits of the User's assigned Role.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}


 
<pre> 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 ] [--uid=value ] [--gid=value ] [--cli-auth=value ] [--alerts=value ] [--account-type=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--hours-term=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
===task-get===
Returns information about the specified task.
 
<pre> qs task-get|t-get --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>task</tt> || ID of a task.
| &nbsp; || <tt>name</tt> || User names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>password</tt> || Password for the user to use when accessing the Storage System via the web management interface, qs CLI, or REST API.
|}
 
 
===task-list===
Returns a list of all the Tasks including active, completed, and failed tasks. Whenever you run a command in the Storage Grid it is queued in the internal Task Manager and then executed automatically once the necessary resource locks are acquired.
 
<pre> qs task-list|t-list [--filtered=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>filtered</tt> || Returns just the 'value' most recently created.
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>first-name</tt> || User's first name: enclose in double-quotes if it contains spaces.
|}
|-
| &nbsp; || <tt>last-name</tt> || User's last name: enclose in double-quotes if it contains spaces.
|-
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>default-chap-user</tt> || Default CHAP username 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>uid</tt> || POSIX user ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
|-
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
| &nbsp; || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management 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>account-type</tt> || Specifies the account type where standard accounts are the default and emergency/temporary account types are for short-term special situations (see NIST 800-53).  These accounts automatically terminate after a specified number of hours. [emergency, *standard, temporary]
|-
| &nbsp; || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
| &nbsp; || <tt>hours-term</tt> || Hours until the account is auto-terminated.  On termination emergency accounts are locked and temporary accounts are removed/deleted.  Unlocking a locked emergency account will add 24 hours to the termination date.
|-
| &nbsp; || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
|-
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}




===task-lock-list===
===user-app-token-add===
Returns a list of internal task object locks for the specified storage system.
Adds a user app token.


<pre> qs task-lock-list|tl-list [--storage-system=value ] [--flags=value ] </pre>
<pre> qs user-app-token-add|u-app-tkn-add --user=value [--name=value ] [--app-key=value ] [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>app-key</tt> || Application provider key
|-
| &nbsp; || <tt>date-token-expires</tt> || Date on which the token expires.
|-
| &nbsp; || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
| &nbsp; || <tt>user-app-token-access-mode</tt> || User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===task-lock-release===
===user-app-token-delete===
Releases the specified internal task object locks on the specified storage system (internal support use only, --force flag required).
Removes a user app token.


<pre> qs task-lock-release|tl-release --task=value [--storage-system=value ] [--flags=value ] </pre>
<pre> qs user-app-token-delete|u-app-tkn-delete --user-app-token=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>task</tt> || ID of a task.
| &nbsp; || <tt>user-app-token</tt> || User app token.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [force]
|}
|}




===task-proceed===
===user-app-token-get===
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.
Gets information about the specified user app token.


<pre> qs task-proceed|t-proceed --task=value [--wait-for-signal=value ] [--flags=value ] </pre>
<pre> qs user-app-token-get|u-app-tkn-get --user-app-token=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>task</tt> || ID of a task.
| &nbsp; || <tt>user-app-token</tt> || User app token.
|-
|-
| &nbsp; || <tt>wait-for-signal</tt> || 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'.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|}
 
 
===user-app-token-list===
Returns a list of user app tokens.
 
<pre> qs user-app-token-list|u-app-tkn-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}


</div>
</div>


==Trace Level Management [TRACE-LEVEL]==
===user-app-token-regen===
Debugging facility used to increase the amount of information sent to the /var/log/qs_service.log
Regenerates a user app token.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>


===event-pulse===
<pre> qs user-app-token-regen|u-app-tkn-regen --user-app-token=value [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
Updates object timestamps of the specified type for the specified system to induce event traffic in the grid for testing purposes.
 
<pre> qs event-pulse|e-pulse --object-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>object-type</tt> || Type of the object to associate the tag with. [alert, disk, host, host-group, pool, port, share, task, user, user-group, *volume]
| &nbsp; || <tt>user-app-token</tt> || User app token.
|-
|-
| &nbsp; || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
| &nbsp; || <tt>date-token-expires</tt> || Date on which the token expires.
|-
| &nbsp; || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
| &nbsp; || <tt>user-app-token-access-mode</tt> || User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===trace-level-get===
===user-generate-otp-auth-secret===
Get the current trace level that is being used for logging.
Generate One-Time-Password (OTP) Authorization secret for the specified user


<pre> qs trace-level-get|tl-get [--flags=value ] </pre>
<pre> qs user-generate-otp-auth-secret|u-generate-otp-auth-secret --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===trace-level-modify===
===user-get===
Modify the current parameters used for logging.
Gets information about the specified user.


<pre> qs trace-level-modify|tl-modify [--trace-level=value ] [--stdout=value ] [--trace-filter=value ] [--trace-options=value ] [--event-verbose-filter=value ] [--flags=value ] </pre>
<pre> qs user-get|u-get --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>trace-level</tt> || This is the trace level you would like the system to use for logging. [always, critical, debug, debug2, *error, info, verbose, warning]
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>stdout</tt> || Whether or not the traces should also be logged to stdout
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
|-
| &nbsp; || <tt>trace-filter</tt> || Specific classes that you would like to have elevated trace levels. Comma-delimited list of classes, containing optional colon-delimited function names. For example: 'service/osn_foo_util.cpp,service/osn_service_bar.cpp:func1:func2'
|-
| &nbsp; || <tt>trace-options</tt> || Specific options for tracing [enable-cpuinfo,disable-cpuinfo,enable-meminfo,disable-meminfo,enable-calllog,disable-calllog,enable-eventlog,disable-eventlog,enable-execlog,disable-execlog,executing,enable-delta-ObjectType,disable-delta-ObjectType]
|-
| &nbsp; || <tt>event-verbose-filter</tt> || Specific object types that you would like to have verbose event logging levels. Comma-delimited list of object types, containing optional colon-delimited event types. For example: 'HwEnclosure:modify:add'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}


</div>
</div>


==User Management [USER]==
===user-list===
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.
Returns a list of all the users.
<div class='mw-collapsible'>
 
<div class='mw-collapsible-content'>
<pre> qs user-list|u-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
 


===user-add===
===user-modify===
Adds a new management User account to the Storage System/Grid.  A matching console level account is created on all grid nodes but by default SSH access is blocked. Rather, management accounts enable the use of qs CLI commands and web management interface access as per the limits of the User's assigned Role.
Modifies the specified user name, multi-factor authentication settings, role, and/or description.


<pre> 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 ] [--uid=value ] [--gid=value ] [--cli-auth=value ] [--alerts=value ] [--account-type=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--hours-term=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
<pre> qs user-modify|u-modify --user=value [--role=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--otp-secret-key=value ] [--uid=value ] [--gid=value ] [--lock-account=value ] [--cli-auth=value ] [--alerts=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || User names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
| &nbsp; || <tt>password</tt> || Password for the user to use when accessing the Storage System via the web management interface, qs CLI, or REST API.
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
| &nbsp; || <tt>first-name</tt> || User's first name: enclose in double-quotes if it contains spaces.
|-
| &nbsp; || <tt>last-name</tt> || User's last name: enclose in double-quotes if it contains spaces.
|-
| &nbsp; || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
Line 9,251: Line 11,037:
|-
|-
| &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>otp-secret-key</tt> || One-Time-Password (OTP) for multifactor authentication.
|-
|-
| &nbsp; || <tt>uid</tt> || POSIX user ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
| &nbsp; || <tt>uid</tt> || POSIX user ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
|-
|-
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
| &nbsp; || <tt>lock-account</tt> || Set to 'true' to lock the account, 'false' to unlock the user account.
|-
|-
| &nbsp; || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management User account.
| &nbsp; || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management 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]
|-
| &nbsp; || <tt>account-type</tt> || Specifies the account type where standard accounts are the default and emergency/temporary account types are for short-term special situations (see NIST 800-53).  These accounts automatically terminate after a specified number of hours. [emergency, *standard, temporary]
|-
|-
| &nbsp; || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
| &nbsp; || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|-
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
| &nbsp; || <tt>hours-term</tt> || Hours until the account is auto-terminated.  On termination emergency accounts are locked and temporary accounts are removed/deleted.  Unlocking a locked emergency account will add 24 hours to the termination date.
|-
|-
| &nbsp; || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
| &nbsp; || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
Line 9,272: Line 11,058:
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===user-app-token-add===
===user-password-set===
Adds a user app token.
Changes the password for the specified user


<pre> qs user-app-token-add|u-app-tkn-add --user=value --name=value --app-key=value [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
<pre> qs user-password-set|passwd --user=value --new-password=value [--old-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>new-password</tt> || New password for the User.
|-
|-
| &nbsp; || <tt>app-key</tt> || Application provider key
| &nbsp; || <tt>old-password</tt> || Old password for the User.
|-
| &nbsp; || <tt>date-token-expires</tt> || Date on which the token expires.
|-
| &nbsp; || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
|-
| &nbsp; || <tt>user-app-token-access-mode</tt> || User app token access mode. [Disabled, *Local only, Remote and Local, Remote only]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===user-app-token-delete===
===user-remove===
Removes a user app token.
Removes the specified user identified by name or ID.


<pre> qs user-app-token-delete|u-app-tkn-delete --user-app-token=value [--flags=value ] </pre>
<pre> qs user-remove|u-remove --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-app-token</tt> || User app token.
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>


===user-app-token-get===
==User Group Management [USER-GROUP]==
Gets information about the specified user app token.
Users can be grouped together to simplify management of Resource Groups.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===user-group-create===
Creates a new storage user group comprised of the specified users.


<pre> qs user-app-token-get|u-app-tkn-get --user-app-token=value [--flags=value ] </pre>
<pre> qs user-group-create|ug-create --name=value [--user-list=value ] [--desc=value ] [--flags=value ] [--gid=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-app-token</tt> || User app token.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
|}
 
 
===user-app-token-list===
Returns a list of user app tokens.
 
<pre> qs user-app-token-list|u-app-tkn-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|}
|}




===user-app-token-regen===
===user-group-delete===
Regenerates a user app token.
Deletes a storage user group, the users are not deleted unless the delete-users flag is set.


<pre> qs user-app-token-regen|u-app-tkn-regen --user-app-token=value [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
<pre> qs user-group-delete|ug-delete --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-app-token</tt> || User app token.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>date-token-expires</tt> || Date on which the token expires.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|-
| &nbsp; || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
| &nbsp; || <tt>user-app-token-access-mode</tt> || User app token access mode. [Disabled, *Local only, Remote and Local, Remote only]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
|}
|}




===user-get===
===user-group-get===
Gets information about the specified user.
Returns information about a specific storage user group.


<pre> qs user-get|u-get --user=value [--flags=value ] </pre>
<pre> qs user-group-get|ug-get --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
Line 9,362: Line 11,139:




===user-list===
===user-group-list===
Returns a list of all the users.
Returns a list of all the storage user groups.


<pre> qs user-list|u-list [--flags=value ] </pre>
<pre> qs user-group-list|ug-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 9,372: Line 11,149:




===user-modify===
===user-group-modify===
Modifies the specified user name, multi-factor authentication settings, role, and/or description.
Modifies the name and/or description of a storage user group.


<pre> qs user-modify|u-modify --user=value [--role=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--uid=value ] [--gid=value ] [--lock-account=value ] [--cli-auth=value ] [--alerts=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
<pre> qs user-group-modify|ug-modify --user-group=value [--name=value ] [--desc=value ] [--gid=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>role</tt> || Name of a security role or its unique ID (GUID).
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>default-chap-user</tt> || Default CHAP username 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>uid</tt> || POSIX user ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
|-
|-
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
|-
| &nbsp; || <tt>lock-account</tt> || Set to 'true' to lock the account, 'false' to unlock the user account.
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
|-
| &nbsp; || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management 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>disable-wui-tabs</tt> || Disables specified tabs in the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
| &nbsp; || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface.  This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
| &nbsp; || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
|-
| &nbsp; || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
|}




===user-password-set===
===user-group-user-add===
Changes the password for the specified user
Adds one or more users to the specified user group.


<pre> qs user-password-set|passwd --user=value --new-password=value [--old-password=value ] [--flags=value ] </pre>
<pre> qs user-group-user-add|ugu-add --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
|-
| &nbsp; || <tt>new-password</tt> || New password for the User.
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
|-
| &nbsp; || <tt>old-password</tt> || Old password for the User.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}




===user-remove===
===user-group-user-remove===
Removes the specified user identified by name or ID.
Removes one or more users from the specified user group


<pre> qs user-remove|u-remove --user=value [--flags=value ] </pre>
<pre> qs user-group-user-remove|ugu-remove --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user</tt> || Name or ID (GUID) of a existing user.
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 9,440: Line 11,197:
</div>
</div>


==User Group Management [USER-GROUP]==
==Storage Volume Management [VOLUME]==
Users can be grouped together to simplify management of Resource Groups.
Commands for the management of Storage Volumes which are block devices which can be presented to Hosts via the iSCSI and/or FC protocols.
<div class='mw-collapsible'>
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
<div class='mw-collapsible-content'>


===user-group-create===
===volume-clone===
Creates a new storage user group comprised of the specified users.
Creates a complete block copy of the source volume.


<pre> qs user-group-create|ug-create --name=value [--user-list=value ] [--desc=value ] [--flags=value ] [--gid=value ] </pre>
<pre> qs volume-clone|v-clone --volume=value [--pool=value ] [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
| &nbsp; || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async]
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|-
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
|}




===user-group-delete===
===volume-create===
Deletes a storage user group, the users are not deleted unless the delete-users flag is set.
Creates a new Storage Volume in the specified storage pool.


<pre> qs user-group-delete|ug-delete --user-group=value [--flags=value ] </pre>
<pre> 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-kb=value ] [--stripesize-kb=value ] [--stripe-count=value ] [--qos-policy=value ] [--volume-profile=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--reserved=value ] [--unmapped=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|}
 
 
===user-group-get===
Returns information about a specific storage user group.
 
<pre> qs user-group-get|ug-get --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [force, min]
| &nbsp; || <tt>desc</tt> || A description for the object.
|}
 
 
===user-group-list===
Returns a list of all the storage user groups.
 
<pre> qs user-group-list|ug-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [min]
| &nbsp; || <tt>percent-reserved</tt> || 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)
|}
 
 
===user-group-modify===
Modifies the name and/or description of a storage user group.
 
<pre> qs user-group-modify|ug-modify --user-group=value [--name=value ] [--desc=value ] [--gid=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
| &nbsp; || <tt>chap-policy</tt> || 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]
|-
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|-
| &nbsp; || <tt>gid</tt> || POSIX group ID to be associated with the specified user account.  New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async]
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
|}
 
 
===user-group-user-add===
Adds one or more users to the specified user group.
 
<pre> qs user-group-user-add|ugu-add --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
| &nbsp; || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
|-
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
| &nbsp; || <tt>stripesize-kb</tt> || Indicates the stripe unit size for the underlying Ceph RBD.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
 
 
===user-group-user-remove===
Removes one or more users from the specified user group
 
<pre> qs user-group-user-remove|ugu-remove --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>user-group</tt> || A group of one or more users.
|-
| &nbsp; || <tt>user-list</tt> || A list of one or more users.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
|}
 
</div>
</div>
 
==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.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>
 
===volume-clone===
Creates a complete block copy of the source volume.
 
<pre> qs volume-clone|v-clone --volume=value [--pool=value ] [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
 
 
===volume-create===
Creates a new Storage Volume in the specified storage pool.
 
<pre> 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-kb=value ] [--stripesize-kb=value ] [--stripe-count=value ] [--qos-policy=value ] [--volume-profile=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--reserved=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
| &nbsp; || <tt>size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
| &nbsp; || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
| &nbsp; || <tt>desc</tt> || A description for the object.
|-
| &nbsp; || <tt>percent-reserved</tt> || 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)
|-
| &nbsp; || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
| &nbsp; || <tt>chap-policy</tt> || 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]
|-
| &nbsp; || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
| &nbsp; || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
| &nbsp; || <tt>count</tt> || The number of volumes to create, default is 1.
|-
| &nbsp; || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
| &nbsp; || <tt>stripesize-kb</tt> || Indicates the stripe unit size for the underlying Ceph RBD.
|-
|-
| &nbsp; || <tt>stripe-count</tt> || Indicates the number of objects to write to per stripe before returning to the first object.
| &nbsp; || <tt>stripe-count</tt> || Indicates the number of objects to write to per stripe before returning to the first object.
Line 9,608: Line 11,260:
| &nbsp; || <tt>sync</tt> || 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]
| &nbsp; || <tt>sync</tt> || 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]
|-
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4)
| &nbsp; || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
| &nbsp; || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|-
| &nbsp; || <tt>copies</tt> || 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).
| &nbsp; || <tt>copies</tt> || 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).
|-
|-
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
| &nbsp; || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
| &nbsp; || <tt>unmapped</tt> || Applies only to scale-out (Ceph) block devices, this option disables mapping of the new Storage Volume (RBD) so that it is never connected to the iSCSI/FC/NVMeoF target driver.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
Line 9,651: Line 11,309:
Deletes a Storage Volume, *WARNING* any data in the volume will be lost.
Deletes a Storage Volume, *WARNING* any data in the volume will be lost.


<pre> qs volume-delete|v-delete --volume=value [--delete-child-snaps=value ] [--flags=value ] </pre>
<pre> qs volume-delete|v-delete [--volume-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
| &nbsp; || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
| &nbsp; || <tt>delete-child-snaps-only</tt> || Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
|-
| &nbsp; || <tt>delete-child-snaps-and-parent</tt> || Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
|-
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|-
| &nbsp; || <tt>delete-child-snaps</tt> || Deletes the child snapshots of the specified share/volume.
| &nbsp; || <tt>dry-run-only</tt> || Dry run will not delete any shares, only returns a list of shares found by the specified search criteria and options
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
Line 9,681: Line 11,345:
|-
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
===volume-hold-add===
Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.
<pre> qs volume-hold-add|v-hld-add --volume=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>hold-tag</tt> || Tag identifying the hold.
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
|}
===volume-hold-remove===
Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.
<pre> qs volume-hold-remove|v-hld-remove --volume=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
| &nbsp; || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [min]
Line 9,699: Line 11,391:
Modifies the name, description or other properties of the Storage Volume.
Modifies the name, description or other properties of the Storage Volume.


<pre> 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 ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--qos-policy=value ] [--volume-profile=value ] [--reserved=value ] </pre>
<pre> 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 ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--qos-policy=value ] [--volume-profile=value ] [--reserved=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 9,724: Line 11,416:
| &nbsp; || <tt>sync</tt> || 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]
| &nbsp; || <tt>sync</tt> || 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]
|-
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4)
| &nbsp; || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
| &nbsp; || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
| &nbsp; || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|-
| &nbsp; || <tt>copies</tt> || 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).
| &nbsp; || <tt>copies</tt> || 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).
Line 9,813: Line 11,509:
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
| &nbsp; || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}
===volume-search===
Returns a subset of Storage Volumes matching the given criteria.
<pre> qs volume-search|v-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
| &nbsp; || <tt>search-filter</tt> || Filter the results of the Storage Volume List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force]
|}
|}


Line 9,912: Line 11,620:
Enables access to the specific volume from the specified host.
Enables access to the specific volume from the specified host.


<pre> qs volume-assign|va-add --volume=value --host-list=value [--free-unused-luns=value ] [--flags=value ] </pre>
<pre> qs volume-assign|va-add --volume=value --host-list=value [--lun=value ] [--free-unused-luns=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
{| cellspacing='0' cellpadding='5'
|-
|-
Line 9,918: Line 11,626:
|-
|-
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
| &nbsp; || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
| &nbsp; || <tt>lun</tt> || FC target Logical Unit Number (LUN) to be applied to the specified Storage Volume.  LUN numbers are only relevant to FC access as all iSCSI targets have unique iqns and use LUN 0.
|-
|-
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 9,951: Line 11,661:
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 9,965: Line 11,675:
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
| &nbsp; || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume.  LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
|-
|-
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 10,096: Line 11,806:
| &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>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


Line 10,110: Line 11,820:
| &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>flags</tt> || Optional flags for the command. [async, force, min, *none]
| &nbsp; || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}
|}


</div>
</div>
</div>
</div>

Latest revision as of 06:03, 27 August 2024

OSNEXUS QuantaStor CLI 6.4.1 Copyright (c) 2009-2024 OSNEXUS Corporation. All rights reserved.

The following QuantaStor CLI command reference documentation is also available from the CLI itself by running 'qs help' and 'qs help --min'. The 'qs' CLI is on every QuantaStor system by default and you can also install it on other systems by downloading the QS CLI package from our downloads page.

USAGE 

   qs COMMAND --mandatory-arg=value [--optional-arg=value] [--flags=force,async,...] [--server=ip,user,passwd] [-u=user,passwd] [--min [--nonames] | --noheader | --verbose | --xml | --json ] 
   qs imode|i  : Interactive mode (CTRL-C to exit)

HELP 

   qs help|h [command-name|partial-command-name] [--min]

OUTPUT MODES 

   --min           : Minimal mode prints command and required arguments plus a brief command 
                      description.
   --verbose       : Verbose mode prints command and all arguments, a brief command description 
                      plus detailed descriptions of each keyword argument.
   --xml           : XML output mode
   --json          : JSON output mode
   --csv           : CSV output mode
   --min --nonames : Blocks automatic conversion of UUIDs to names (see disk-list, tp-list).

SERVER AUTHENTICATION 

   --server=ipaddress[,username,password] : Comma separated values, no spaces.

   qs CLI will attempt to authenticate with the default 'admin','password' if username and password 
   are not supplied. You may also provide authentication credentials by setting and exporting the 
   QS_SERVER environment variable (export QS_SERVER=ipaddress[,username[,password]]) or by placing 
   the credentials in the file '~/.qs.cnf' (e.g., 192.168.0.10,admin,password).

EXAMPLES 

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

SEE ALSO 

   qs-sendlogs <companyname>   : Sends a log report to support for analysis
   qs-iostat                   : Shows device and pool IO statistics
   qs-version                  : Shows version information about the local CLI, service, and grid nodes.
   qs-status                   : Shows the status of the key service daemons
   qs-showlog                  : Prints the service log, use -f to tail the log, -e to check for errors & warnings
   qs-util                     : Various system and common RAID controller utility commands
   qs-zconvert                 : For importing and converting foreign OpenZFS filesystems with the QuantaStor naming conventions.

COMMAND

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=<search>' for help on all commands which contain the specified search value. 

 qs help|h [--command=value ] [--category=value ] [--wiki=value ] [--api=value ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


tc-commands

List of commands for tab completion 

 qs tc-commands [--command=value ] [--flags=value ]
  command Command to show method args for.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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, Slack, 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 --filter=value [--ack=value ] [--close=value ] [--flags=value ]
  filter Specify a comma delimited list of one or more Alerts to be removed/cleared. Alerts may be identified by UUID or by strings which will be matched against the title and description text.
  ack Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
  close Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


alert-clear-all

Clears all the alerts. 

 qs alert-clear-all|a-clear-all [--ack=value ] [--close=value ] [--flags=value ]
  ack Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
  close Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


alert-config-get

Alert configuration settings indicate where alert notifications should be sent. 

 qs alert-config-get|ac-get [--flags=value ]
  flags Optional flags for the command. [force, min]


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 ] [--pool-freespace-warning=value ] [--pool-freespace-urgent=value ] [--pool-freespace-critical=value ] [--share-freespace-warning=value ] [--share-freespace-urgent=value ] [--share-freespace-critical=value ] [--enable-syslog=value ] [--endpoints=value ] [--enable-alerts=value ] [--disable-alerts=value ] [--pause-alerts=value ] [--snmp-user=value ] [--snmp-password=value ] [--flags=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.
  pool-freespace-warning The percentage (default=30) of free-space left in a pool at which a warning is sent to indicate pool growth plans should be made.
  pool-freespace-urgent The percentage (default=10) of free-space left in a pool at which alerts are generated.
  pool-freespace-critical The percentage (default=5) of free-space left in a pool at which all provisioning operations are blocked.
  share-freespace-warning The percentage (default=20) of free-space left in a share quota at which a 'warning' alert is raise to indicate the share is low on space.
  share-freespace-urgent The percentage (default=10) of free-space left in a share quota at which a 'urgent' alert is generated.
  share-freespace-critical The percentage (default=5) of free-space left in a share quota at which a 'critically low' alert is raised and writes will soon begin to be blocked.
  enable-syslog Enable alerts appended to '/var/log/syslog'.
  endpoints Add new endpoints by specifying a comma delimited list in the format "module:endpointurl,module:endpointurl" and use the ~ prefix to remove entries.
  enable-alerts Enables previously disabled alerts, use '*' to enable all disabled alert triggers.
  disable-alerts Disables the specified alert types/triggers. Specify specific triggers by UUID or by the SNMP trap index.
  pause-alerts Pauses the specified alert types/triggers for 30 days.
  snmp-user SNMP User name
  snmp-password SNMP User password
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


alert-get

Gets information about a specific alert. 

 qs alert-get|a-get --id=value [--flags=value ]
  id Unique identifier (GUID) for the object.
  flags Optional flags for the command. [force, min]


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 [--filter=value ] [--ack=value ] [--close=value ] [--filtered=value ] [--flags=value ]
  filter Specify a comma delimited list of one or more Alerts to be removed/cleared. Alerts may be identified by UUID or by strings which will be matched against the title and description text.
  ack Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
  close Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
  filtered Returns just the 'value' most recently created.
  flags Optional flags for the command. [min]


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 ] [--flags=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]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


alert-type-get

Returns information about a specific Alert Type/trigger. 

 qs alert-type-get|at-get --alert-trigger=value [--flags=value ]
  alert-trigger Alert types/triggers can be turned on, off or paused for 30 days to reduce noise during maintenance.
  flags Optional flags for the command. [min]


alert-type-list

Returns a list of all the Alert Types/triggers and their state (enabled/disabled/paused) 

 qs alert-type-list|at-list [--flags=value ]
  flags Optional flags for the command. [min]


audit-log-list

List audit log entries from the specified Storage System. 

 qs audit-log-list|audit-list [--max-entries=value ] [--storage-system=value ] [--audit-user=value ] [--audit-entry-types=value ] [--flags=value ]
  max-entries Maximum number of audit log entries to return, default 100.
  storage-system Name or ID of a Storage System in a management grid.
  audit-user Only gather audit entries associated with the specified user UUID.
  audit-entry-types Only gather audit entries of the specified type [alert, api, message, *none, task]
  flags Optional flags for the command. [min]


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 ] [--flags=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.
  flags Optional flags for the command. [min]

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-get

Returns detailed information on a specific backup job. 

 qs backup-job-get|bj-get --job=value [--flags=value ]
  job A Backup Job contains the active state of a backup run associated with a Backup Policy including the start time and the number of files copied.
  flags Optional flags for the command. [force, min]


backup-job-list

Returns a list of backup jobs in the system. 

 qs backup-job-list|bj-list [--flags=value ]
  flags Optional flags for the command. [min]


backup-policy-create

Creates a Backup Policy which can copy/move data to from NAS shares and Cloud Containers. 

 qs backup-policy-create|bp-create --name=value --network-share=value --remote-hostname=value [--remote-export-path=value ] [--remote-export-type=value ] [--desc=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-mode=value ] [--filter-string=value ] [--size-threshold=value ] [--auto-copy=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  network-share Name or ID of a CIFS/NFS Network Share.
  remote-hostname Hostname/IP address to a remote NFS/SMB server or the UUID of a Cloud Container.
  remote-export-path Remote export directory path for NFS export, SMB share.
  remote-export-type Remote export mount type. [cloudcontainer, *nfs, smb]
  desc A description for the object.
  retain-rules Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
  policy-type Backup policy types. [*copy-inbound, copy-outbound, move-inbound, move-outbound]
  scan-threads Number of concurrent threads for walking/scanning the specified target export (default: 5)
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  hours (calendar based) 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 (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  offset-minutes (calendar based) 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.
  max-snaps Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  rc-hourly Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-weeklies Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-monthlies Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-quarterlies Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  retain-period Max age of files in days until they are purged (default: 0 / never delete files).
  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.
  age-days-min Minimum number of days old the file must be for it to be backed up by the Backup Policy. Setting this to 0 indicates no minimum age.
  age-days-max Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.
  create-links Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
  force-remove-tiered Links are created once a day. Using this option will force creation of links on every trigger.
  remote-export-sub-path Destination sub-directory.
  filter-mode Filter files based on the mode and the filter string matching. [exclude, include, *none]
  filter-string Filter any files which contain the specified pattern from the backup policy. See 'Filter Mode'.
  size-threshold The minimum size for a file to be included in the backup.
  auto-copy Supplies real-time data protection by automatically copying files to a destination share.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


backup-policy-delete

Deletes the specified backup policy. 

 qs backup-policy-delete|bp-delete --policy=value [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


backup-policy-disable

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

 qs backup-policy-disable|bp-disable --policy=value [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


backup-policy-enable

Enables a backup policy that was previously disabled. 

 qs backup-policy-enable|bp-enable --policy=value [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


backup-policy-get

Returns detailed information on a specific backup policy. 

 qs backup-policy-get|bp-get --policy=value [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  flags Optional flags for the command. [force, min]


backup-policy-list

Returns a list of backup policies in the system. 

 qs backup-policy-list|bp-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=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 ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-mode=value ] [--filter-string=value ] [--size-threshold=value ] [--auto-copy=value ] [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  remote-hostname Hostname/IP address to a remote NFS/SMB server or the UUID of a Cloud Container.
  remote-export-path Remote export directory path for NFS export, SMB share.
  remote-export-type Remote export mount type. [cloudcontainer, *nfs, smb]
  retain-rules Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
  policy-type Backup policy types. [*copy-inbound, copy-outbound, move-inbound, move-outbound]
  scan-threads Number of concurrent threads for walking/scanning the specified target export (default: 5)
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  hours (calendar based) 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 (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  offset-minutes (calendar based) 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.
  max-snaps Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  rc-hourly Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-weeklies Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-monthlies Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-quarterlies Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  retain-period Max age of files in days until they are purged (default: 0 / never delete files).
  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.
  age-days-min Minimum number of days old the file must be for it to be backed up by the Backup Policy. Setting this to 0 indicates no minimum age.
  age-days-max Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.
  create-links Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
  force-remove-tiered Links are created once a day. Using this option will force creation of links on every trigger.
  remote-export-sub-path Destination sub-directory.
  filter-mode Filter files based on the mode and the filter string matching. [exclude, include, *none]
  filter-string Filter any files which contain the specified pattern from the backup policy. See 'Filter Mode'.
  size-threshold The minimum size for a file to be included in the backup.
  auto-copy Supplies real-time data protection by automatically copying files to a destination share.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


backup-policy-trigger

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

 qs backup-policy-trigger|bp-trigger --policy=value [--flags=value ]
  policy A Backup Policy name or ID which is associated with a Network Share to do backups.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Scale-out Object / Ceph Management [CEPH]

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

bucket-cleanup-orphans

Cleans up orphaned bucket objects that were not removed properly as part of a previous bucket delete. 

 qs bucket-cleanup-orphans|b-cleanup-orphans [--ceph-cluster=value ] [--concurrency=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  concurrency Level of per node concurrency of 'rados rm' calls for the removal of orphan objects operation from 1 to 10 with a default of 4.
  flags Optional flags for the operation. [async]


bucket-create

Creates a new S3 bucket in the specified Ceph Cluster. 

 qs bucket-create|b-create --name=value --s3-user=value [--ceph-cluster=value ] [--bucket-acl=value ] [--quota-size=value ] [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--estimated-objects=value ] [--count=value ] [--integration-options=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  s3-user Ceph object storage S3 User.
  ceph-cluster Ceph Cluster name or ID.
  bucket-acl Indicates the type of user access provided to the bucket. [auth-read, *private, public-read, public-read-write]
  quota-size Size of the quota in bytes with optional suffix (MB, GB, TB)
  object-lock-mode Indicates the object lock mode. If object locking is disabled during bucket create, it cannot be enabled again. 'governance' mode allows modifications by an admin and 'compliance' allows no modifications (WORM mode). [compliance, *disabled, enabled, governance]
  object-lock-duration-days Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
  enable-lifecycle-policy Enables life cycle policy on the bucket.
  lifecycle-policy-days The number of life cycle policy days for objects in the given bucket.
  enable-nfs Enable NFS sharing of the cloud container.
  estimated-objects Estimated number objects in the bucket based on a 4MB object size. [100M, 10M, 1B, 1M, 500M, 50M, Dynamic]
  count The number of volumes to create, default is 1.
  integration-options Enable/disable quantastor thrid party integrations. [*none, veeam]
  flags Optional flags for the operation. [async]


bucket-delete

Deletes the specified S3 bucket and all objects contained within. 

 qs bucket-delete|b-delete --bucket-list=value [--ceph-cluster=value ] [--flags=value ]
  bucket-list Comma delimited list of the Names or IDs of S3 Object Storage Buckets.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async]


bucket-get

Returns detailed information about a specific bucket. 

 qs bucket-get|b-get --bucket=value [--ceph-cluster=value ] [--flags=value ]
  bucket Name or ID of an S3 object storage bucket.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [force, min]


bucket-list

Returns a list of all the buckets. 

 qs bucket-list|b-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


bucket-modify

Modify the bucket attributes. 

 qs bucket-modify|b-modify --bucket=value [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--integration-options=value ] [--flags=value ]
  bucket Name or ID of an S3 object storage bucket.
  object-lock-mode Indicates the object lock mode. If object locking is disabled during bucket create, it cannot be enabled again. 'governance' mode allows modifications by an admin and 'compliance' allows no modifications (WORM mode). [compliance, *disabled, enabled, governance]
  object-lock-duration-days Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
  enable-lifecycle-policy Enables life cycle policy on the bucket.
  lifecycle-policy-days The number of life cycle policy days for objects in the given bucket.
  enable-nfs Enable NFS sharing of the cloud container.
  integration-options Enable/disable quantastor thrid party integrations. [*none, veeam]
  flags Optional flags for the operation. [async]


bucket-obj-list

Returns a list of all the S3 objects within the specified bucket. 

 qs bucket-obj-list|b-obj-list --bucket=value [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  bucket Name or ID of an S3 object storage bucket.
  flags Optional flags for the command. [min]


bucket-rescan

Scans for any new S3 buckets that have been created. 

 qs bucket-rescan|b-rescan [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async]


bucket-search

Searches for a bucket based on a set of parameters. 

 qs bucket-search|b-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ]
  search-filter Filter the results of the bucket List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  max-results Maximum number of results to return for the given search parameters.
  offset Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
  flags Optional flags for the command. [async, force]


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 ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  storage-system Name or ID of a Storage System in a management grid.
  port Name or unique ID of a 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.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


ceph-cluster-create

Create a new Ceph Cluster using the specified Storage System(s). 

 qs ceph-cluster-create|cc-create --name=value --client-ips=value [--backend-ips=value ] [--desc=value ] [--domain-suffix=value ] [--public-network=value ] [--cluster-network=value ] [--cluster-auth-mode=value ] [--osd-out-subtree-limit=value ] [--enable-osd-encryption=value ] [--encryption-mode=value ] [--enable-osd-compression=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--key-server-profile=value ] [--flags=value ]
  name Name of the Ceph Cluster.
  client-ips List of IP addresses used to identify which systems and which ports to use for the Ceph Cluster front-end/client communication ports.
  backend-ips List of IP addresses used to identify which ports are to be used for Ceph Cluster inter-node back-end communication, if not specified the list specified for the front-end ports will be used.
  desc A description for the object.
  domain-suffix The domain name suffix for your network such as example.com
  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.
  cluster-auth-mode Encryption mode used between Ceph services of 'cephx' or 'none', default is 'cephx'. [*cephx, none]
  osd-out-subtree-limit Indicates the scope at which a group of OSDs in the 'down' state should not be thrown 'out'. Default is 'host' so that OSDs are not removed from a given cluster due to server hardware maintenance activities. [*host, rack]
  enable-osd-encryption Enables inline encryption for OSDs using AES 256 bit encryption for data-at-rest. (default: disabled)
  encryption-mode Type of encryption, software (luks) or self-encryption (SED). [SED, *default, luks]
  enable-osd-compression Enables inline compression for OSDs using the 'snappy' algorithm. (default: disabled)
  osd-down-timeout-sec Amount of time until a given unresponsive OSD is switched to the 'down' state. OSDs in the 'down' state will auto sync and recover when they come back online.
  osd-out-timeout-sec Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
  key-server-profile Identifier for Key Server Profile.
  flags Optional flags for the operation. [async, force, forget-missing, 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, forget-missing, 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, forget-missing, min, *none]


ceph-cluster-get

Gets information about a specific Ceph Cluster. 

 qs ceph-cluster-get|cc-get --ceph-cluster=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [force, min]


ceph-cluster-health-event-list

Returns a list of all the active Ceph Cluster health check event. 

 qs ceph-cluster-health-event-list|cc-health-event-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


ceph-cluster-import

Import an existing Ceph Cluster. 

 qs ceph-cluster-import|cc-import [--name=value ] [--description=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


ceph-cluster-list

Returns a list of all the Ceph Clusters. 

 qs ceph-cluster-list|cc-list [--flags=value ]
  flags Optional flags for the command. [min]


ceph-cluster-member-get

Gets information about a specific Ceph Cluster Member. 

 qs ceph-cluster-member-get|ccm-get --ceph-cluster-member=value [--flags=value ]
  ceph-cluster-member Ceph Cluster Member name or ID.
  flags Optional flags for the command. [force, min]


ceph-cluster-member-list

Returns a list of all the Ceph Cluster Member systems. 

 qs ceph-cluster-member-list|ccm-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


ceph-cluster-modify

Modify a Ceph Cluster using the specified Storage System(s). 

 qs ceph-cluster-modify|cc-modify --ceph-cluster=value [--name=value ] [--desc=value ] [--flags=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--near-fill-full-percent=value ] [--back-fill-full-percent=value ] [--full-percent=value ] [--key-server-profile=value ] [--config-options-list=value ]
  ceph-cluster Ceph Cluster name or ID.
  name Name of the Ceph Cluster.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]
  osd-down-timeout-sec Amount of time until a given unresponsive OSD is switched to the 'down' state. OSDs in the 'down' state will auto sync and recover when they come back online.
  osd-out-timeout-sec Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
  near-fill-full-percent Cluster storage percentage at which a warning will be generated to indicate the cluster is near full.
  back-fill-full-percent Cluster storage percentage at which cluster blocks backfills from starting.
  full-percent Cluster storage percentage at which cluster is full and clients are stopped from writing data.
  key-server-profile Identifier for Key Server Profile.
  config-options-list General Ceph Cluster configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.


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, forget-missing, min, *none]


ceph-cluster-service-event-delete

Delete/archive a list of ceph cluster service events 

 qs ceph-cluster-service-event-delete|cc-srv-event-delete [--ceph-cluster=value ] [--prune-events=value ] [--service-event-id-list=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  prune-events Prune specified service event. Default is to archive the event.
  service-event-id-list Ceph Cluster service crash event ID list.
  flags Optional flags for the command. [min]


ceph-cluster-service-event-list

Returns a list of Ceph Cluster service crash events. 

 qs ceph-cluster-service-event-list|cc-srv-event-list [--ceph-cluster=value ] [--include-old-events=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  include-old-events List old and new events. Default is to include only new events.
  flags Optional flags for the command. [min]


ceph-crush-rule-create-erasure

Create a custom Ceph CRUSH rule for object or block storage. 

 qs ceph-crush-rule-create-erasure|ccr-create-era --rule=value --ceph-cluster=value --ec-pool-profile=value [--desc=value ] [--flags=value ]
  rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  ec-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  desc A description for the object.
  flags Optional flags for the operation. [async]


ceph-crush-rule-create-replicated

Create a custom Ceph CRUSH rule for object or block storage. 

 qs ceph-crush-rule-create-replicated|ccr-create-rep --rule=value --ceph-cluster=value --rule-deviceclass=value [--desc=value ] [--rule-failuredomain=value ] [--rule-root=value ] [--flags=value ]
  rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  rule-deviceclass ssd | nvme )
  desc A description for the object.
  rule-failuredomain osd | rack )
  rule-root Ceph CRUSH rule, root ( *default )
  flags Optional flags for the operation. [async]


ceph-crush-rule-delete

Deletes the specified Ceph CRUSH rule. 

 qs ceph-crush-rule-delete|ccr-delete --rule=value [--flags=value ]
  rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [async]


ceph-crush-rule-get

Gets information about a specific Ceph CRUSH rule. 

 qs ceph-crush-rule-get|ccr-get --rule=value [--flags=value ]
  rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [min]


ceph-crush-rule-list

Returns a list of all the Ceph CRUSH rule(s) present in the cluster. 

 qs ceph-crush-rule-list|ccr-list --ceph-cluster=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


ceph-ec-profile-create

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

 qs ceph-ec-profile-create|ecp-create --k=value --m=value [--name=value ] [--ceph-cluster=value ] [--desc=value ] [--profile-failure-domain=value ] [--profile-technique=value ] [--ec-plugin=value ] [--device-class=value ] [--flags=value ]
  k Data chunk (k) count for erasure coded Ceph Pool.
  m Check-sum (m) chunk count for erasure coded Ceph Pool.
  name Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  desc A description for the object.
  profile-failure-domain Failure domain for the Ceph Pool {Default: host}.
  profile-technique Erasure coding technique for Ceph Pool. {Default: reed-solomon-van}
  ec-plugin Plug-in used for erasure coded Ceph Pool {*jerasure, isa, lrc, shec}
  device-class Device class to pin the pool to. {hdd, ssd, nvme}
  flags Optional flags for the operation. [async]


ceph-ec-profile-delete

Deletes the specified ceph pool profile. 

 qs ceph-ec-profile-delete|ecp-delete --ec-pool-profile=value [--flags=value ]
  ec-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [async]


ceph-ec-profile-get

Gets information about a specific ceph pool profile. 

 qs ceph-ec-profile-get|ecp-get --ec-pool-profile=value [--flags=value ]
  ec-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-ec-profile-list

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

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


ceph-metadata-server-add

Configure a new metadata server in the Ceph Cluster. 

 qs ceph-metadata-server-add|cmds-add --ceph-cluster=value --ceph-cluster-member-list=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-cluster-member-list List of Ceph Cluster Member name or ID.
  flags Optional flags for the operation. [async]


ceph-metadata-server-get

Gets information about a specific CephFS metadata server in the Ceph Cluster. 

 qs ceph-metadata-server-get|cmds-get --ceph-metadata-server=value [--flags=value ]
  ceph-metadata-server Ceph Metadata server name or ID.
  flags Optional flags for the command. [force, min]


ceph-metadata-server-list

Returns a list of all the CephFS metadata servers configured in the Ceph Cluster. 

 qs ceph-metadata-server-list|cmds-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


ceph-metadata-server-remove

Removes the specified ceph metadata server. 

 qs ceph-metadata-server-remove|cmds-remove --ceph-cluster=value --ceph-metadata-server=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-metadata-server Ceph Metadata server name or ID.
  flags Optional flags for the operation. [async]


ceph-monitor-add

Configure a new monitor for the Ceph Cluster. 

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


ceph-monitor-get

Gets information about a specific Ceph Monitor. 

 qs ceph-monitor-get|cmon-get --ceph-monitor=value [--flags=value ]
  ceph-monitor Ceph Monitor service name or ID.
  flags Optional flags for the command. [force, min]


ceph-monitor-list

Returns a list of all the Ceph Monitors. 

 qs ceph-monitor-list|cmon-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


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]


ceph-osd-delete

Deletes the specified list of Ceph OSDs 

 qs ceph-osd-delete|osd-delete --osd-list=value [--ceph-cluster=value ] [--flags=value ]
  osd-list Lists all Ceph OSDs.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async]


ceph-osd-get

Gets information about a specific Ceph Object Storage Daemon. 

 qs ceph-osd-get|osd-get --ceph-osd=value [--flags=value ]
  ceph-osd Ceph OSD name or ID.
  flags Optional flags for the command. [force, min]


ceph-osd-identify

Identify/blink the specified ceph OSD 

 qs ceph-osd-identify|osd-identify --osd-list=value [--blink-type=value ] [--duration=value ] [--ceph-cluster=value ] [--flags=value ]
  osd-list Lists all Ceph OSDs.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async]


ceph-osd-key-replace

Replaces encryption key for encrypted OSD. 

 qs ceph-osd-key-replace|osd-krep --ceph-cluster=value --osd-list=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  osd-list Lists all Ceph OSDs.
  flags Optional flags for the operation. [async]


ceph-osd-list

Returns a list of all the Ceph Object Storage Daemons 

 qs ceph-osd-list|osd-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


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 OSD name or ID.
  desc A description for the object.
  flags Optional flags for the operation. [async]


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-devices=value ] [--enable-mirror=value ] [--quick-format-disks=value ] [--allow-mixed-size-journal-media=value ] [--force-external-journal-device=value ] [--enable-dynamic-weighting=value ] [--wal-size=value ] [--db-size=value ] [--osd-type=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. Disk filter tags may also be used, see disk-list help for details.
  journal-ssd-list List of comma separated SSD disk ID to be used for OSD journal devices during OSD create. Disk filter tags may also be used, see disk-list help for details.
  use-unused-journal-devices Use unused journal devices on Storage System for OSD create.
  enable-mirror Enable mirrored Ceph Journal Devices to prevent Ceph OSD loss.
  quick-format-disks Quick format the disks selected for OSD and Journal Device creation.
  allow-mixed-size-journal-media Allow disk of different sizes to be paired for mirrored journals.
  force-external-journal-device When the physical disk(s) supplied for OSD create are SSD/NVME but still want a journal wal/db device.
  enable-dynamic-weighting Weights will be calculated based on size and applied to OSDs during creation if set to true. Weights will be auto initialized by ceph if set to false.
  wal-size Size of the Ceph Journal Device used as a Write Ahead Log (WAL).
  db-size Size of the Ceph Journal Device used for metadata offload.
  osd-type Ceph OSD type can be Bluestore or Filestore. [*auto-select, bluestore, filestore]
  flags Optional flags for the operation. [async]


ceph-osd-replace

Replaces prepared OSDs 

 qs ceph-osd-replace|osd-rep --disk=value --ceph-osd=value --storage-system=value [--flags=value ]
  disk Name of the physical disk or its unique ID/serial number.
  ceph-osd Ceph OSD name or ID.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async]


ceph-osd-replace-prep

Prepares selected OSDs to be replaced 

 qs ceph-osd-replace-prep|osd-rep-prep --ceph-osd=value [--storage-system=value ] [--flags=value ]
  ceph-osd Ceph OSD name or ID.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async]


ceph-osd-reweight

Reweight the given set of ceph OSDs to the specified weight. 

 qs ceph-osd-reweight|osd-rw --osd-weight-list=value [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  osd-weight-list List of comma separated OSD IDs and the requested associated capacity percentage, given in the form '5:10,13:5,12:0' etc
  flags Optional flags for the operation. [async]


ceph-osd-service-update

Start/Stop/Restart the specified Ceph OSD service 

 qs ceph-osd-service-update|osd-serv-up --osd-list=value [--service-update-mode=value ] [--ceph-cluster=value ] [--flags=value ]
  osd-list Lists all Ceph OSDs.
  service-update-mode Ceph OSD service update mode [restart, *start, stop]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async]


ceph-pool-create

Creates a new low-level Ceph Pool used as Ceph Block Pool. 

 qs ceph-pool-create|cpool-create --name=value --ceph-cluster=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--pool-type=value ] [--rule-name=value ] [--use-case=value ] [--cache-tier=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ceph-cluster Ceph Cluster name or ID.
  desc A description for the object.
  scaling-factor Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
  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.
  k Data chunk (k) count for erasure coded Ceph Pool.
  m Check-sum (m) chunk count for erasure coded Ceph Pool.
  pool-type Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
  rule-name Ceph crush map rule set name. ('default', if not specified)
  use-case Default use case is S3 object storage but Openstack based pools may also be created in addition. [*block, file, object]
  cache-tier Creates an additional SSD pool as a write-back cache tier layered over the underlying HDD/EC based pool.
  flags Optional flags for the operation. [async]


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]


ceph-pool-get

Gets information about a specific Ceph Pool. 

 qs ceph-pool-get|cpool-get --ceph-pool=value [--flags=value ]
  ceph-pool Ceph Pool name or ID.
  flags Optional flags for the command. [force, min]


ceph-pool-list

Returns a list of all the Ceph storage pools. 

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


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 ] [--rule=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-pool Ceph Pool name or ID.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  max-replicas Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
  rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [async]


load-balancer-get

Gets information about a specific load balancer instance. 

 qs load-balancer-get|lb-get --load-balancer=value [--flags=value ]
  load-balancer Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
  flags Optional flags for the command. [force, min]


load-balancer-list

Returns a list of all the load balancers for the specified Ceph Cluster or all instances if no cluster is specified. 

 qs load-balancer-list|lb-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


s3-gateway-add

Configures/adds a new S3 Object Storage Gateway (Ceph RGW) on a system within a given Ceph Cluster. 

 qs s3-gateway-add|rgw-add --gw-ipaddress-list=value [--ceph-cluster=value ] [--gw-port=value ] [--service-engine=value ] [--service-mode=value ] [--tcp-no-delay=value ] [--certificate-pem-data=value ] [--redirect-gateway-port=value ] [--load-balancer=value ] [--mapping-mode=value ] [--flags=value ]
  gw-ipaddress-list Command separated list of IP addresses for S3 Object Storage Gateway (Ceph RGW).
  ceph-cluster Ceph Cluster name or ID.
  gw-port Port used by S3 Object Storage Gateway. [*7480, 7481]
  service-engine Service engine type for the RADOS Gateway [*beast, civetweb]
  service-mode Service engine mode for the RADOS Gateway [http, *https]
  tcp-no-delay This enables the TCP_NODELAY=1 option in beast mode to speed up object storage operations for low latency SSD and NVMe media.
  certificate-pem-data File path to PEM file with certificate and key block for RGW S3 gateway SSL access.
  redirect-gateway-port Redirect port 80 and 443 to the Gateway port 7480. Note that the Quantastor WUI will stop working on this port but may be accessed via HTTPS via alternate port 8080.
  load-balancer Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
  mapping-mode Configures what protocol the load balancer uses and how that maps to the back-end RGW/S3 Gateway. [auto, http-to-http, *https-to-http, https-to-https]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-gateway-get

Gets information about a specific S3 Object Storage Gateway (Ceph RGW). 

 qs s3-gateway-get|rgw-get --ceph-gateway=value [--flags=value ]
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the command. [force, min]


s3-gateway-list

Returns a list of all the configured S3 Object Storage Gateways (Ceph RGW). 

 qs s3-gateway-list|rgw-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


s3-gateway-modify

Adds/removes custom configurtion options for the specified S3 Object Storage Gateway (Ceph RGW). 

 qs s3-gateway-modify|rgw-modify --ceph-cluster=value --ceph-gateway=value --rgw-options-list=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  rgw-options-list Ceph Rados Gateway configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-gateway-remove

Removes the specified S3 Object Storage Gateway (Ceph RGW). 

 qs s3-gateway-remove|rgw-remove --ceph-cluster=value --ceph-gateway=value [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the operation. [async]


s3-gateway-restart

Restarts the radosgw service. 

 qs s3-gateway-restart|rgw-restart --ceph-gateway=value [--flags=value ]
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-gateway-start

Starts the ceph radosgw service. 

 qs s3-gateway-start|rgw-start --ceph-gateway=value [--flags=value ]
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-gateway-stop

Stops the ceph radosgw service. 

 qs s3-gateway-stop|rgw-stop --ceph-gateway=value [--flags=value ]
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-quota-set-global

Set the global S3 Quota defaults for all users in a given Ceph Cluster. 

 qs s3-quota-set-global|s3q-set-global --ceph-cluster=value --max-objects=value --bucket-quota-max-size=value --max-user-objects=value --max-user-size=value [--max-objects-enable=value ] [--max-size-enable=value ] [--max-user-objects-enable=value ] [--max-user-size-enable=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  max-objects-enable Enable maximum object limits per bucket.
  max-objects Maximum object count per bucket.
  max-size-enable Enable maximum bucket size limits.
  bucket-quota-max-size Maximum amount of data for a given bucket.
  max-user-objects-enable Enable maximum object count limits per user.
  max-user-objects Maximum aggregate number objects that a given user can create.
  max-user-size-enable Enable maximum aggregate capacity/size limits for a given user.
  max-user-size Maximum aggregate capacity limit for a given user or user(s).
  flags Optional flags for the operation. [min]

Ceph Client Resource Management [CEPH-CLIENT]

Commands for managing client connections to ceph resources.

ceph-client-conf-export

Exports a client ceph.conf file to default location '/etc/ceph/qs-ceph.conf', unless the 'output-file' arguemnt is provided. 

 qs ceph-client-conf-export|ccc-export --ceph-cluster=value [--output-file=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  output-file Name of file to which input is written
  flags Optional flags for the operation. [min]


ceph-client-keyring-create

Creates a ceph client registered to a set of ceph resources. 

 qs ceph-client-keyring-create|cckr-create --name=value --client-key-type=value --resource-list=value [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  client-key-type An enum to identify the type of resource the client keyring is associeted with. [cephfs, *rbd]
  resource-list A list of either RBD pools or CephFS shares to be associated with the client.
  flags Optional flags for the operation. [min]


ceph-client-keyring-delete

Deletes an existing ceph client. 

 qs ceph-client-keyring-delete|cckr-delete --ceph-client=value [--flags=value ]
  ceph-client Ceph client name or uuid
  flags Optional flags for the operation. [min]


ceph-client-keyring-export

Exports keyring file to default location '/etc/ceph/ceph.client.<name>.keyring', unless the 'output-file' arguemnt is provided. 

 qs ceph-client-keyring-export|cckr-export --ceph-client=value [--output-file=value ] [--flags=value ]
  ceph-client Ceph client name or uuid
  output-file Name of file to which input is written
  flags Optional flags for the operation. [min]


ceph-client-keyring-get

Returns ceph client by name or UUID. 

 qs ceph-client-keyring-get|cckr-get --ceph-client=value [--flags=value ]
  ceph-client Ceph client name or uuid
  flags Optional flags for the operation. [min]


ceph-client-keyring-list

Lists all known ceph clients. 

 qs ceph-client-keyring-list|cckr-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


ceph-client-keyring-resource-assoc-enum

Lists all known ceph cluster resource associations. 

 qs ceph-client-keyring-resource-assoc-enum|cckr-assoc-enum [--ceph-client=value ] [--flags=value ]
  ceph-client Ceph client name or uuid
  flags Optional flags for the operation. [min]


ceph-client-keyring-resource-assoc-get

Get the keyring association, identified by composite key 'ceph-client' + 'resource' 

 qs ceph-client-keyring-resource-assoc-get|cckr-assoc-get --ceph-client=value --resource=value [--flags=value ]
  ceph-client Ceph client name or uuid
  resource The unique id of a volume or volume group or share or host or host group.
  flags Optional flags for the operation. [min]

Ceph Journal Management [CEPHJOURNAL]

Commands for management, monitoring, and configuration of Ceph Journal Groups and Ceph Journal Devices.

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 [--flags=value ]
  ceph-journal-device Ceph Journal Device name or ID.
  flags Optional flags for the operation. [async]


ceph-journal-get

Returns details of a specific Ceph Journal Device. 

 qs ceph-journal-get|cj-get --ceph-journal-device=value [--flags=value ]
  ceph-journal-device Ceph Journal Device name or ID.
  flags Optional flags for the command. [force, min]


ceph-journal-group-create

Creates a Ceph Journal Group out of the specified device(s). If two devices are specified, the Journal Group will create the group as a RAID1 mirrored group to ensure fault-tolerance in the event of a device failure. All systems should use mirrored Journal Groups to ensure OSDs do not need to be rebuilt due to a journal group device failure. 

 qs ceph-journal-group-create|cjg-create --primary-disk=value [--secondary-disk=value ] [--flags=value ]
  primary-disk Disk to be used as the underlying hardware for a Ceph Journal Group.
  secondary-disk Disk to be used as the underlying hardware for a Ceph Journal Group.
  flags Optional flags for the operation. [async]


ceph-journal-group-delete

Deletes a Ceph Journal Group and all underlying Ceph Journal Devices to free up the underlying media for reuse. 

 qs ceph-journal-group-delete|cjg-delete --ceph-journal-group=value [--flags=value ]
  ceph-journal-group Ceph Journal Group name or ID.
  flags Optional flags for the operation. [async]


ceph-journal-group-get

Returns details of a specific Ceph Journal Group. 

 qs ceph-journal-group-get|cjg-get --ceph-journal-group=value [--flags=value ]
  ceph-journal-group Ceph Journal Group name or ID.
  flags Optional flags for the operation. [force, min]


ceph-journal-group-list

Returns a list of all the Ceph Journal Groups. 

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


ceph-journal-list

Returns a list of all the Ceph Journal Devices. 

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


ceph-journal-migrate

Migrate an OSD's Journal Device. 

 qs ceph-journal-migrate|cj-migrate --ceph-cluster=value --ceph-journal-device=value [--ceph-journal-group=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-journal-device Ceph Journal Device name or ID.
  ceph-journal-group Ceph Journal Group name or ID.
  flags Optional flags for the command. [async]

CephFS Management [CEPHFS]

Commands for scale-out NAS filesystem setup within a managed Ceph Cluster.

ceph-filesystem-create

Creates a new Ceph Filesystem for the Ceph Cluster to enable scale-out Network Share provisioning and access. 

 qs ceph-filesystem-create|cephfs-create --name=value --ceph-cluster=value --pool-type=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--rule-name=value ] [--active-mds-count=value ] [--standby-mds-count=value ] [--auto-config-nfs=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ceph-cluster Ceph Cluster name or ID.
  pool-type Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
  desc A description for the object.
  scaling-factor Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
  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.
  k Data chunk (k) count for erasure coded Ceph Pool.
  m Check-sum (m) chunk count for erasure coded Ceph Pool.
  rule-name Ceph crush map rule set name. ('default', if not specified)
  active-mds-count Number of active MDS instances
  standby-mds-count Number of standby MDS instances
  auto-config-nfs Auto configure NFS services for scale-out storage.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


ceph-filesystem-delete

Deletes the specified Ceph Filesystem, WARNING all associated files and Ceph Pools will be destroyed. 

 qs ceph-filesystem-delete|cephfs-delete --ceph-filesystem=value [--flags=value ]
  ceph-filesystem Ceph Filesystem with associated data and metadata Ceph Pools.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


ceph-filesystem-get

Returns information about a specific Ceph Filesystem instance. 

 qs ceph-filesystem-get|cephfs-get --ceph-filesystem=value [--flags=value ]
  ceph-filesystem Ceph Filesystem with associated data and metadata Ceph Pools.
  flags Optional flags for the operation. [min]


ceph-filesystem-list

Returns a list of all the Ceph Filesystems. 

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


ceph-filesystem-modify

Modifies the settings for the specified Ceph Filesystem. 

 qs ceph-filesystem-modify|cephfs-modify --ceph-filesystem=value [--desc=value ] [--flags=value ] [--active-mds-count=value ] [--standby-mds-count=value ]
  ceph-filesystem Ceph Filesystem with associated data and metadata Ceph Pools.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]
  active-mds-count Number of active MDS instances
  standby-mds-count Number of standby MDS instances

Cloud Container Management [CLOUD-CONTAINER]

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

cloud-cache-default-settings-get

Get the default Cloud Container cache settings 

 qs cloud-cache-default-settings-get|cc-def-settings-get --storage-system=value [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [force, min]


cloud-cache-default-settings-modify

Modify the default Cloud Container cache settings 

 qs cloud-cache-default-settings-modify|cc-def-settings-mod --cloud-settings=value [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ]
  cloud-settings Global cloud settings for a system
  vfs-cache-mode Cloud container cache mode [*default, full, minimal, off, writes]
  dir-cache-time Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
  cache-share-id Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
  buffer-size Cloud container cache buffer size.
  vfs-cache-max-age Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
  vfs-cache-max-size Cloud container max size of objects in the cache. If not specified, there is no limit.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-add

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

 qs cloud-container-add|clcn-add --provider-creds=value --location=value --bucket-name=value [--encryption-key=value ] [--enable-nfs=value ] [--attach-to=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ]
  provider-creds Credential ID for accessing your cloud storage provider account.
  location Cloud storage provider endpoint location.
  bucket-name The cloud container name used to identify a cloud backup container.
  encryption-key A passphrase which is used to encrypt all the data sent to the storage resource.
  enable-nfs Enable NFS sharing of the cloud container.
  attach-to Appliance to attached the cloud container to. If not specified it will attach to the system the CLI/API call is routed to.
  mount-options Customized mount options for the cloud container to optimize cache and other settings for a given workload.
  storage-class Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
  vfs-cache-mode Cloud container cache mode [*default, full, minimal, off, writes]
  dir-cache-time Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
  cache-share-id Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
  buffer-size Cloud container cache buffer size.
  vfs-cache-max-age Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
  vfs-cache-max-size Cloud container max size of objects in the cache. If not specified, there is no limit.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-bucket-scan

Scans for available buckets using the specified cloud provider credentials. 

 qs cloud-container-bucket-scan|clcn-bucket-scan --provider-creds=value --location-tag=value [--flags=value ]
  provider-creds Credential ID for accessing your cloud storage provider account.
  location-tag Location tag of the endpoint such as sjc01, not always required.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-create

Creates a cloud backup container into which cloud backups of Storage Volumes can be made. 

 qs cloud-container-create|clcn-create --name=value --provider-creds=value --location=value [--desc=value ] [--attach-to=value ] [--enable-nfs=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  provider-creds Credential ID for accessing your cloud storage provider account.
  location Cloud storage provider endpoint location.
  attach-to Appliance to attached the cloud container to. If not specified it will attach to the system the CLI/API call is routed to.
  enable-nfs Enable NFS sharing of the cloud container.
  mount-options Customized mount options for the cloud container to optimize cache and other settings for a given workload.
  storage-class Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
  vfs-cache-mode Cloud container cache mode [*default, full, minimal, off, writes]
  dir-cache-time Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
  cache-share-id Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
  buffer-size Cloud container cache buffer size.
  vfs-cache-max-age Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
  vfs-cache-max-size Cloud container max size of objects in the cache. If not specified, there is no limit.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-delete

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

 qs cloud-container-delete|clcn-delete --container=value [--delete-cloud-bucket=value ] [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  delete-cloud-bucket Delete the bucket from the cloud.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-disable

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

 qs cloud-container-disable|clcn-disable --container=value [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-enable

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

 qs cloud-container-enable|clcn-enable --container=value [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-get

Returns detailed information on a specific cloud backup container. 

 qs cloud-container-get|clcn-get --container=value [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  flags Optional flags for the command. [force, min]


cloud-container-list

Returns a list of cloud backup containers in the system. 

 qs cloud-container-list|clcn-list [--flags=value ]
  flags Optional flags for the command. [min]


cloud-container-repair

Repairs the specified cloud backup container. 

 qs cloud-container-repair|clcn-repair --container=value [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-container-rescan

Clears stale/cached metadata so that the Cloud Container presents the most current file and directory information. 

 qs cloud-container-rescan|clcn-rescan --container=value [--flags=value ]
  container A cloud backup container into which Network Shares can be backed up.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-provider-add

Adds a new private cloud object storage provider entry. 

 qs cloud-provider-add|clp-add --name=value --location-name=value --location-tag=value --location-endpoint=value [--desc=value ] [--access-key=value ] [--secret-key=value ] [--project-id=value ] [--auth-file=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  location-name Friendly name of the endpoint location.
  location-tag Location tag of the endpoint such as sjc01, not always required.
  location-endpoint FQDN/URL of the end-point
  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.
  auth-file Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
  flags Optional flags for the command. [min]


cloud-provider-credentials-add

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

 qs cloud-provider-credentials-add|clpc-add --provider=value --access-key=value --secret-key=value [--project-id=value ] [--auth-file=value ] [--flags=value ]
  provider Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3 Compatible object storage Cloud Providers may be added for private 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.
  auth-file Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-provider-credentials-get

Returns information about the specified cloud provider credential. 

 qs cloud-provider-credentials-get|clpc-get --provider-creds=value [--flags=value ]
  provider-creds Credential ID for accessing your cloud storage provider account.
  flags Optional flags for the command. [force, min]


cloud-provider-credentials-list

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

 qs cloud-provider-credentials-list|clpc-list [--flags=value ]
  flags Optional flags for the command. [min]


cloud-provider-credentials-remove

Removes the specified cloud provider credentials 

 qs cloud-provider-credentials-remove|clpc-remove --provider-creds=value [--flags=value ]
  provider-creds Credential ID for accessing your cloud storage provider account.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cloud-provider-get

Returns detailed information about the specified cloud provider. 

 qs cloud-provider-get|clp-get --provider=value [--flags=value ]
  provider Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3 Compatible object storage Cloud Providers may be added for private cloud.
  flags Optional flags for the command. [force, min]


cloud-provider-list

Returns the list of supported cloud providers. 

 qs cloud-provider-list|clp-list [--flags=value ]
  flags Optional flags for the command. [min]


cloud-provider-location-add

Adds a new endpoint location to an existing private cloud object storage provider. 

 qs cloud-provider-location-add|clpl-add --provider=value --location-name=value --location-tag=value --location-endpoint=value [--flags=value ]
  provider Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3 Compatible object storage Cloud Providers may be added for private cloud.
  location-name Friendly name of the endpoint location.
  location-tag Location tag of the endpoint such as sjc01, not always required.
  location-endpoint FQDN/URL of the end-point
  flags Optional flags for the command. [min]


cloud-provider-location-get

Returns details of the specified cloud provider location endpoint. 

 qs cloud-provider-location-get|clpl-get --location=value [--flags=value ]
  location ID or name of a cloud provider location endpoint.
  flags Optional flags for the command. [force, min]


cloud-provider-location-list

Returns a list of all the object storage location endpoints in the grid. 

 qs cloud-provider-location-list|clpl-list [--flags=value ]
  flags Optional flags for the command. [min]


cloud-provider-location-remove

Removes the specified location endpoint from a cloud object storage provider entry. 

 qs cloud-provider-location-remove|clpl-remove --location=value [--flags=value ]
  location ID or name of a cloud provider location endpoint.
  flags Optional flags for the command. [min]


cloud-provider-storage-class-add

Adds a mew storage class for a cloud provider 

 qs cloud-provider-storage-class-add|clpsc-add --provider=value --storage-class-tag=value --storage-description=value [--flags=value ]
  provider Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3 Compatible object storage Cloud Providers may be added for private cloud.
  storage-class-tag Tag for the Cloud Provider Storage Class
  storage-description Description of the Cloud Provider Storage Class
  flags Optional flags for the command. [min]


cloud-provider-storage-class-get

Returns information about the specified Cloud Provider Storage Class 

 qs cloud-provider-storage-class-get|clpsc-get --storage-class=value [--flags=value ]
  storage-class Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
  flags Optional flags for the command. [force, min]


cloud-provider-storage-class-list

Returns a list of Cloud Provider Storage Class 

 qs cloud-provider-storage-class-list|clpsc-list [--flags=value ]
  flags Optional flags for the command. [min]


cloud-provider-storage-class-remove

Removes the specified storage class 

 qs cloud-provider-storage-class-remove|clpsc-remove --storage-class=value [--flags=value ]
  storage-class Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
  flags Optional flags for the command. [min]

Container Management [CONTAINER]

Commands for the management of Containers which are objects that describe the instances of docker containers and their various configurations.

service-config-create

Creates a new Service Config with the specified configuration options. 

 qs service-config-create|serv-conf-create --name=value --service-definition-tag=value [--service-config-options-list=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  service-definition-tag The tag of the Service Definition desired for the Service. [resilio, vsftp]
  service-config-options-list List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
  flags Optional flags for the operation. [async]


service-config-delete

Deletes the specified Service Config. 

 qs service-config-delete|serv-conf-delete --service-config=value [--flags=value ]
  service-config ID or name of Service Config.
  flags Optional flags for the operation. [async]


service-config-get

Returns the specified Service Config. 

 qs service-config-get|serv-conf-get --service-config=value [--flags=value ]
  service-config ID or name of Service Config.
  flags Optional flags for the operation. [async]


service-config-list

Returns a list of Service Configs. 

 qs service-config-list|serv-conf-list [--flags=value ]
  flags Optional flags for the operation. [async]


service-config-option-add

Adds key=value style options to the given Service Config. 

 qs service-config-option-add|serv-conf-opt-add --service-config=value --service-config-options-list=value [--flags=value ]
  service-config ID or name of Service Config.
  service-config-options-list List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
  flags Optional flags for the operation. [async]


service-config-option-get

Returns the specified Service Config Option. 

 qs service-config-option-get|serv-conf-opt-get --service-config=value --key=value [--flags=value ]
  service-config ID or name of Service Config.
  key A Service Config Option key.
  flags Optional flags for the operation. [async]


service-config-option-remove

Removes key=value style options from the given Service Config. 

 qs service-config-option-remove|serv-conf-opt-remove --service-config=value --service-config-options-list=value [--flags=value ]
  service-config ID or name of Service Config.
  service-config-options-list List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
  flags Optional flags for the operation. [async]


service-config-option-set

Modify key=value style options from the given Service Config. 

 qs service-config-option-set|serv-conf-opt-set --service-config=value --service-config-options-list=value [--flags=value ]
  service-config ID or name of Service Config.
  service-config-options-list List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
  flags Optional flags for the operation. [async]


service-config-options-list

Lists all key=value options associated with the given Service Config. 

 qs service-config-options-list|serv-conf-opt-list --service-config=value [--flags=value ]
  service-config ID or name of Service Config.
  flags Optional flags for the operation. [async]


service-def-get

Returns the specified Service Definition. 

 qs service-def-get|serv-def-get --id=value [--flags=value ]
  id Unique identifier (GUID) for the object.
  flags Optional flags for the operation. [min]


service-def-list

Returns a list of all Service Definitions. 

 qs service-def-list|serv-def-list [--flags=value ]
  flags Optional flags for the operation. [min]


service-get

Returns the specified Service. 

 qs service-get|serv-get --service-id=value [--flags=value ]
  service-id The name or ID of a Service.
  flags Optional flags for the operation. [min]


service-list

Returns a list of all Services. 

 qs service-list|serv-list [--flags=value ]
  flags Optional flags for the operation. [min]

Physical Disk Management [DISK]

Physical Disks represent storage media (SATA, SAS, nVME, SSD, HW RAID LVs, etc) that appear to the system via HBAs and internal controllers.

disk-copy

Copies data from a Physical Disk or Storage Volume to a new Physical Disk, Storage Volume, or Network Share file. 

 qs disk-copy|disk-cp --source-id=value --target-id=value --source-type=value --target-type=value [--target-name=value ] [--blocksize-kb=value ] [--target-format=value ] [--flags=value ]
  source-id ID of the source Physical Disk or Storage Volume to be copied.
  target-id ID of the target Physical Disk, Network Share, or Storage Volume's Pool where data will be copied to.
  source-type Type of media where data will be copied from (Physical Disk or Storage Volume). [*disk, volume]
  target-type Type of media where data will be copied to (Physical Disk, Storage Volume, or Network Share [*disk, share, volume]
  target-name Name of the target Storage Volume or file in the target Network Share.
  blocksize-kb Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
  target-format Image type of the data once copied (Defaults to raw). [qcow, *raw, vhd, vmdk]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


disk-format

Removes all encryption settings, partitions, does a quick format of the device, and then optionally shreds the contents. 

 qs disk-format|pd-format --disk-list=value [--shred-mode=value ] [--release-io-fence=value ] [--flags=value ]
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  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]
  release-io-fence Release all I/O fence reservations for the specified disk(s)
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


disk-get

Gets information about a specific physical disk. 

 qs disk-get|pd-get --disk=value [--flags=value ]
  disk Name of the physical disk or its unique ID/serial number.
  flags Optional flags for the operation. [force, min]


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 (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async, force, forget-missing, 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, forget-missing, 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  flags Optional flags for the operation. [async, force, forget-missing, 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async, force, forget-missing, 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 ] [--blink-type=value ] [--flags=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 remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


disk-list

Enumerates all physical disks. 

 qs disk-list|pd-list [--filter=value ] [--normalize=value ] [--flags=value ]
  filter Filter may include disk names/IDs, Storage System names/IDs, storage pool names/IDs, and a [N] identifier to select unused disks where N is the number of unused disks to select, [nopaths] to indicate no paths of a mulitpath or encrypted device, [paths] to only show paths, [used] to indicate only disks that are in use, [unused] to indicate disks that are available, [eq:SIZE] such as [eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].
  normalize Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
  flags Optional flags for the operation. [min]


disk-multipath-config-add

Adds physical disk multipath configuration entries. 

 qs disk-multipath-config-add|dmpc-add --device-tag-list=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  device-tag-list List of physical disk multipath tag strings: 'vendor:product'
  flags Optional flags for the operation. [min]


disk-multipath-config-list

Enumerates physical disk multipath configuration entries. 

 qs disk-multipath-config-list|dmpc-list [--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]


disk-multipath-config-remove

Removes physical disk multipath configuration entries. 

 qs disk-multipath-config-remove|dmpc-remove --device-tag-list=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  device-tag-list List of physical disk multipath tag strings: 'vendor:product'
  flags Optional flags for the operation. [min]


disk-multipath-config-scan

Scans physical disks for multipath capability. 

 qs disk-multipath-config-scan|dmpc-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]


disk-performance-test

Performs performance tests on physical disks. 

 qs disk-performance-test|pd-perftest --disk-list=value [--perf-test-type=value ] [--block-size=value ] [--block-count=value ] [--flags=value ]
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  perf-test-type The type of performance test to be performed. [*read-sequential]
  block-size Volume block size in string format, such as 512, 1k, 2k, 4k, 8k, 16k, 32k, 64k, 128k, 256k, 512k, 1M, 2M, etc
  block-count Number of blocks
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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 ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [min]


disk-search

Returns a subset of Physical Disk objects matching the given criteria. 

 qs disk-search|pd-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Physical Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force]


disk-sed-hard-reset

Performs a hard PSID reset on the specified self-encrypting disk. 

 qs disk-sed-hard-reset|pd-sed-reset --disk-list=value --psid-passphrase=value [--options=value ] [--flags=value ]
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  psid-passphrase Physical Secure ID/passphrase.
  options Special options - reserved.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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]

External System Managementd [EXTERNALSYSTEM]

Commands for managing and discovering External Systems.

external-system-assign-media

Creates a Software Adapter to assign the specified list of External System Media devices to a Storage System. 

 qs external-system-assign-media|ext-sys-assign-media --storage-system=value --external-system-media-list=value [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  external-system-media-list A comma separated list of External System Media IDs, or the name/ID of an External System or External System Credentials to add all Media from an External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-controller-get

Returns information on the desired External System Controller. 

 qs external-system-controller-get|ext-sys-cntrlr-get --external-system-controller=value [--external-system=value ] [--flags=value ]
  external-system-controller Name or ID of the requested External System Controller.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-controller-list

Returns a list of the discovered External System Controllers for a specified External System. 

 qs external-system-controller-list|ext-sys-cntrlr-list [--external-system=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-credentials-add

Adds the required credentials for discovering an External System. 

 qs external-system-credentials-add|ext-sys-creds-add --name=value --ext-system-username=value --ext-system-password=value --primary-ip=value --secondary-ip=value [--external-system-type=value ] [--storage-system=value ] [--site-cluster=value ] [--port=value ] [--insecure=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ext-system-username The username for accessing the External System.
  ext-system-password The password for accessing the External System.
  primary-ip Primary IP used to discover External Systems
  secondary-ip Secondary IP used to discover External Systems if the primary IP fails.
  external-system-type Type of External System [corvault, *openflex]
  storage-system Name or ID of a Storage System in a management grid.
  site-cluster The name or ID of a site cluster.
  port Port number to run External System discovery against.
  insecure Use insecure http if specified to true, else use secure https by default.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-credentials-get

Returns the credentials information about the specified External System. 

 qs external-system-credentials-get|ext-sys-creds-get --ext-system-credentials=value [--flags=value ]
  ext-system-credentials ID or name of the requested External System Credentials.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-credentials-list

Returns a list of all the credentials for External System discovery. 

 qs external-system-credentials-list|ext-sys-creds-list [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-credentials-remove

Remove credentials for discovering a specified External System. 

 qs external-system-credentials-remove|ext-sys-creds-remove --name=value --ext-system-username=value --ext-system-password=value [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ext-system-username The username for accessing the External System.
  ext-system-password The password for accessing the External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-get

Returns information on a specified discovered External System. 

 qs external-system-get|ext-sys-get --external-system=value [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-host-get

Returns information on the specified discovered External System Host 

 qs external-system-host-get|ext-sys-host-get --external-system-host=value [--flags=value ]
  external-system-host The name or ID of the requested External System Host.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-host-list

Returns a list of discovered External System Hosts 

 qs external-system-host-list|ext-sys-host-list --external-system=value [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-host-volume-assoc-list

Returns a list of the External System Host to Volume associations. 

 qs external-system-host-volume-assoc-list|ext-sys-host-vol-assoc-list [--external-system=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-list

Returns a list of all the discovered External Systems. 

 qs external-system-list|ext-sys-list [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-media-get

Returns information on a specified discovered External System Media device. 

 qs external-system-media-get|ext-sys-med-get --external-system-media=value [--external-system=value ] [--flags=value ]
  external-system-media Name or ID of the requested External System Media device.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-media-list

Returns a list of the discovered Media devices for a specified External System or specified External System Port Group. 

 qs external-system-media-list|ext-sys-med-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  external-system-port-group Name or ID of the requested External System Port Group.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-modify

Modifies the properties of an External System such as an alternative name, description, and enclosure layout. 

 qs external-system-modify|ext-sys-modify --external-system=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  alt-name Alternate name for an External System.
  description A description for the object.
  enclosure-layout Enclosure layout for an External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-pool-get

Returns information on a specified Pool from a specified External System. 

 qs external-system-pool-get|ext-sys-port-pool-get --external-system-pool=value [--external-system=value ] [--flags=value ]
  external-system-pool Name or ID of the requested External System Pool.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-pool-list

Returns a list of discovered Pools from a specified External System. 

 qs external-system-pool-list|ext-sys-pool-list [--external-system=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-port-get

Returns information on a specified Port on a discovered External System. 

 qs external-system-port-get|ext-sys-port-get --external-system-port=value [--external-system=value ] [--flags=value ]
  external-system-port Name or ID of the requested External System Port.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-port-group-get

Returns information on the desired External System Port Group. 

 qs external-system-port-group-get|ext-sys-port-grp-get --external-system-port-group=value [--external-system=value ] [--flags=value ]
  external-system-port-group Name or ID of the requested External System Port Group.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-port-group-list

Returns a list of discovered Port Groups from a specified External System. 

 qs external-system-port-group-list|ext-sys-port-grp-list [--external-system=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-port-list

Returns a list of discovered Ports on a specified External System or a specified External System Port Group. 

 qs external-system-port-list|ext-sys-port-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  external-system-port-group Name or ID of the requested External System Port Group.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-port-modify

Modifies the properties of an External System Port such as IP and subnet mask. 

 qs external-system-port-modify|ext-sys-port-modify --external-system-port=value [--external-system=value ] [--ip-address=value ] [--subnet=value ] [--flags=value ]
  external-system-port Name or ID of the requested External System Port.
  external-system Name or ID of the requested External System.
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  subnet The subnet of an IP address (defaults to /16)
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-profile-apply

Configures a previously discovered External System according to the given External System Profile. 

 qs external-system-profile-apply|ext-sys-prof-apply --external-system=value --external-system-profile=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ]
  external-system Name or ID of the requested External System.
  external-system-profile Name or ID of a given External System Profile.
  volume-count Number of External System Volumes to batch create.
  max-volume-size If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
  volume-size Size of batch created External System Volumes.
  assign-to-hosts External System Volumes will be assigned to the given list of Hosts after creation of volumes.
  host-list A list of one or more hosts by name or ID.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-profile-get

Returns the specified External System Profile. 

 qs external-system-profile-get|ext-sys-prof-get --external-system-profile=value [--flags=value ]
  external-system-profile Name or ID of a given External System Profile.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-profile-list

Returns a list of the available External System Profiles. 

 qs external-system-profile-list|ext-sys-prof-list [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-scan

Scan for discoverable External Systems. 

 qs external-system-scan|ext-sys-scan [--ext-system-credentials=value ] [--storage-system=value ] [--flags=value ]
  ext-system-credentials ID or name of the requested External System Credentials.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-volume-create

Batch creates External System Volumes on the given External System Pool. 

 qs external-system-volume-create|ext-sys-vol-create --external-system-pool=value --volume-name-prefix=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ]
  external-system-pool Name or ID of the requested External System Pool.
  volume-name-prefix Prefix to use for new External System Volumes.
  volume-count Number of External System Volumes to batch create.
  max-volume-size If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
  volume-size Size of batch created External System Volumes.
  assign-to-hosts External System Volumes will be assigned to the given list of Hosts after creation of volumes.
  host-list A list of one or more hosts by name or ID.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-volume-delete

Deletes a list of External System Volumes. 

 qs external-system-volume-delete|ext-sys-vol-del --external-system-volume-list=value [--flags=value ]
  external-system-volume-list A comma separated list of External System Volume IDs, or the name/ID of an External System or External System Credentials to add all Volumes from an External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-volume-get

Returns information on a specified External System Volume. 

 qs external-system-volume-get|ext-sys-vol-get --external-system-volume=value [--external-system=value ] [--flags=value ]
  external-system-volume Name or ID of the requested External System Volume.
  external-system Name or ID of the requested External System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


external-system-volume-list

Returns a list of the discovered Volume from the specified External System or from the specified External System Pool. 

 qs external-system-volume-list|ext-sys-vol-list [--external-system=value ] [--external-system-pool=value ] [--flags=value ]
  external-system Name or ID of the requested External System.
  external-system-pool Name or ID of the requested External System Pool.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]

Fc Remote Port Management [FC-REMOTE-PORT]

{CATEGORY DESCRIPTION GOES HERE}

fc-remote-port-enum

List all remote FC port WWNs visible to FC target ports in the Storage System. 

 qs fc-remote-port-enum|fcrp-enum --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]


fc-remote-port-get

Details of a specific FC remote port. 

 qs fc-remote-port-get|fcrp-get --remote-port=value [--flags=value ]
  remote-port FC WWN of a remote server's initiator port.
  flags Optional flags for the operation. [min]

Storage System Grid Management [GRID]

Commands for management and formation of Storage Grids which are comprised of one or more Storage Systems. Storage Grids simplify 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 ] [--flags=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.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


grid-delete

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

 qs grid-delete|mg-delete [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


grid-get

Get general information about the Storage System management grid. 

 qs grid-get|mg-get [--flags=value ]
  flags Optional flags for the command. [force, min]


grid-merge

Merges two storage grids into one. 

 qs grid-merge|mg-merge --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=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.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


grid-modify

Modify the management grid properties. 

 qs grid-modify|mg-modify --name=value [--desc=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


grid-remove

Removes the specified Storage System from the management grid. 

 qs grid-remove|mg-remove --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, forget-missing, min, *none]


grid-send-supportlogs

Collect support logs from Storage Systems specified (default, all systems in the grid) and send to OSNEXUS tech support. 

 qs grid-send-supportlogs|mg-send-supportlogs [--system-list=value ] [--disable-scrub=value ] [--disable-upload=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  disable-scrub Disables scrubbing of the logs before uploading. By default logs are scrubbed before uploading for improved security and GDPR compliance.
  disable-upload Disables uploading of the logs for systems deployed with no internet access. In this mode the logs must be manually downloaded from the system using scp or other utility and then sent to support.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


grid-set-master

Sets the master node for a Storage System. 

 qs grid-set-master|mg-set --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, forget-missing, min, *none]


grid-split

Splits / sub-divides a storage grid into two grids. 

 qs grid-split|mg-split --name=value [--system-list=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  system-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]

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 Storage Pool High-Availability Group to failover can occur on a system outage. 

 qs ha-group-activate|hag-activate --ha-group=value [--flags=value ]
  ha-group Name or UUID of a Storage Pool High-Availability Group
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


ha-group-create

Creates a new Storage Pool High-Availability Group. 

 qs ha-group-create|hag-create --pool=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  sys-primary Storage system associated with the failover group primary node
  sys-secondary Storage system associated with the failover group secondary node
  sys-tertiary Storage system associated with the failover group tertiary node
  settle-time Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
  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 responding 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]
  fc-port-linkstate-policy Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
  export-timeout Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively. If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
  enforce-smb-allowed Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
  enforce-nfs-allowed Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


ha-group-deactivate

Deactivates the specified Storage Pool High-Availability Group so that failover policies are disabled. 

 qs ha-group-deactivate|hag-deactivate --ha-group=value [--flags=value ]
  ha-group Name or UUID of a Storage Pool High-Availability Group
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


ha-group-delete

Deletes the specified Storage Pool High-Availability Group. 

 qs ha-group-delete|hag-delete --ha-group=value [--flags=value ]
  ha-group Name or UUID of a Storage Pool High-Availability Group
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 --import-health-checks=value --export-health-checks=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.
  import-health-checks Review failover health status events of the target Storage System.
  export-health-checks Review failover health status events of the source Storage System.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


ha-group-get

Gets information about the specified storage pool HA group 

 qs ha-group-get|hag-get --ha-group=value [--flags=value ]
  ha-group Name or UUID of a Storage Pool High-Availability Group
  flags Optional flags for the command. [force, min]


ha-group-list

Returns a list of all the HA groups 

 qs ha-group-list|hag-list [--flags=value ]
  flags Optional flags for the command. [min]


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-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--enable-tertiary-node=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ]
  ha-group Name or UUID of a Storage Pool High-Availability Group
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  sys-primary Storage system associated with the failover group primary node
  sys-secondary Storage system associated with the failover group secondary node
  sys-tertiary Storage system associated with the failover group tertiary node
  enable-tertiary-node Enable an HA group to have a tertiary failover node.
  settle-time Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
  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 responding 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]
  fc-port-linkstate-policy Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
  export-timeout Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively. If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
  enforce-smb-allowed Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
  enforce-nfs-allowed Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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 ] [--mac-address=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=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.
  mac-address MAC Address
  iscsi-enable Enables or disables iSCSI access to the specified port(s).
  nvmeof-enable Enables or disables NVMEoF TCP access to the specified port(s).
  fqdn When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
  convert-vif Convert existing local virtual ip address into an HA site VIF.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


ha-interface-delete

Deletes the specified virtual network interface resource from the HA group 

 qs ha-interface-delete|hai-delete --ha-interface=value [--convert-to-vif=value ] [--flags=value ]
  ha-interface Name or UUID of a Storage Pool High-Availability virtual network interface
  convert-to-vif Convert HA site VIF resource into a local virtual ip address.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


ha-interface-get

Gets information about the specified storage pool HA virtual network interface 

 qs ha-interface-get|hai-get --ha-interface=value [--flags=value ]
  ha-interface Name or UUID of a Storage Pool High-Availability virtual network interface
  flags Optional flags for the command. [force, min]


ha-interface-list

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

 qs ha-interface-list|hai-list [--flags=value ]
  flags Optional flags for the command. [min]


network-check

Verified connectivity to all clients and Storage Systems associted with the specified system as well as any additional IP addresses specified. 

 qs network-check|net-check [--storage-system=value ] [--verify-client-ips=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  verify-client-ips IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Health Checks [HEALTH-CHECKER]

Operations for various health checks.

ha-group-check-health-status

Runs a health check to evaluate failover ability of the given Storage Pool(s) and returns the results. 

 qs ha-group-check-health-status|hag-check-health-status --pool-list=value [--flags=value ]
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]


ha-group-get-health-status

Returns the health status and failover ability of the given Storage Pool(s). 

 qs ha-group-get-health-status|hag-get-health-status --pool-list=value [--flags=value ]
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]

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 Storage 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  iqn Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
  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 [--flags=value ]
  host Name of the host or its unique ID (GUID).
  flags Optional flags for the command. [force, min]


host-initiator-add

Adds an additional iSCSI host initiator IQN or FC WWPN to the specified host. 

 qs host-initiator-add|hi-add --host=value --iqn=value [--flags=value ]
  host Name of the host or its unique ID (GUID).
  iqn Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


host-initiator-get

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

 qs host-initiator-get|hi-get --iqn=value [--flags=value ]
  iqn Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
  flags Optional flags for the command. [force, min]


host-initiator-list

Returns a list of all the initiators iSCSI IQNs and FC WWPNs of the specified host 

 qs host-initiator-list|hi-list --host=value [--flags=value ]
  host Name of the host or its unique ID (GUID).
  flags Optional flags for the command. [min]


host-initiator-remove

Removes a iSCSI IQN or FC WWPN host initiator entry from the specified Host. 

 qs host-initiator-remove|hi-remove --host=value --iqn=value [--flags=value ]
  host Name of the host or its unique ID (GUID).
  iqn Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


host-list

Returns a list of all the Hosts that you have added to the Storage 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 [--flags=value ]
  flags Optional flags for the command. [min]


host-modify

Modifies a host entry which contains a list of WWPN or IQN 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 [--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 command. [force, min]


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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


host-group-list

Returns a list of all the host groups. 

 qs host-group-list|hg-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=value ]
  host-group An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  flags Optional flags for the command. [async]

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/Events that have been recorded for the specified Hardware Controller. 

 qs hw-alarm-clear-all|hwa-clear-all --controller=value [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-alarm-get

Returns information about a specific Hardware Alarm. 

 qs hw-alarm-get|hwa-get --id=value [--flags=value ]
  id Unique identifier (GUID) for the object.
  flags Optional flags for the command. [force, min]


hw-alarm-list

Returns a list of all the current Hardware Alarms/Event messages generated from Hardware Controllers. 

 qs hw-alarm-list|hwa-list [--controller=value ] [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [min]


hw-controller-change-security-key

Change the security key for encryption on SED/FDE-enabled drives on Hardware Controller. 

 qs hw-controller-change-security-key|hwc-change-security-key --controller=value --old-security-key=value --security-key=value [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-controller-create-security-key

Create the security key for encryption on SED/FDE-enabled drives on Hardware Controller. 

 qs hw-controller-create-security-key|hwc-create-security-key --controller=value --security-key=value [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-controller-get

Returns information about a specific Hardware Controller. 

 qs hw-controller-get|hwc-get --controller=value [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [force, min]


hw-controller-group-get

Returns information about all the support Hardware Controller Group types. 

 qs hw-controller-group-get|hwcg-get --controller-group=value [--flags=value ]
  controller-group Name or ID of a hardware RAID controller group.
  flags Optional flags for the command. [force, min]


hw-controller-group-list

Returns a list of all the Hardware Controller Groups. 

 qs hw-controller-group-list|hwcg-list [--flags=value ]
  flags Optional flags for the command. [min]


hw-controller-import-units

Scan and import foreign disks associated with Hardware Controller Groups that were attached to another Hardware Controller or that require re-importing to the local appliance. 

 qs hw-controller-import-units|hwc-import-units --controller=value [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-controller-list

Returns a list of all the Hardware Controllers. 

 qs hw-controller-list|hwc-list [--controller-group=value ] [--flags=value ]
  controller-group Name or ID of a hardware RAID controller group.
  flags Optional flags for the command. [min]


hw-controller-rescan

Rescans the Hardware Controller to look for new disks and RAID units. 

 qs hw-controller-rescan|hwc-rescan --controller=value [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-controller-rescan-all

Rescans the system to rediscover all Hardware Controller and to look for new disks and RAID units on all controllers. 

 qs hw-controller-rescan-all|hwc-rescan-all [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-controller-search

Returns a subset of HW Controller objects matching the given criteria. 

 qs hw-controller-search|hwc-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Hardware Controller List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force]


hw-disk-clear-missing

Clears all the hardware disk devices which are marked as missing and are no longer present. This clears that information from the internal grid database. 

 qs hw-disk-clear-missing|hwd-clear-missing [--controller=value ] [--storage-system=value ] [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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-list=value --controller=value [--flags=value ]
  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, forget-missing, min, *none]


hw-disk-get

Returns information about a specific disk managed by a Hardware Controller. 

 qs hw-disk-get|hwd-get --disk=value [--flags=value ]
  disk Specifies a physical disk connected to a hardware RAID controller.
  flags Optional flags for the command. [force, min]


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 [--disk-list=value ] [--controller=value ] [--blink-type=value ] [--duration=value ] [--flags=value ]
  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.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


hw-disk-list

Returns a list of all the disks managed by the specified Hardware Controller. 

 qs hw-disk-list|hwd-list [--controller=value ] [--normalize=value ] [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  normalize Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
  flags Optional flags for the command. [min]


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 Hardware Controller has in 'bad' or 'failed' state. 

 qs hw-disk-mark-good|hwd-mark-good --disk-list=value --controller=value [--flags=value ]
  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, forget-missing, min, *none]


hw-disk-mark-spare

Marks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached. 

 qs hw-disk-mark-spare|hwd-mark-spare --disk-list=value --controller=value [--flags=value ]
  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, forget-missing, min, *none]


hw-disk-search

Returns a subset of HW Disk objects matching the given criteria. 

 qs hw-disk-search|hwd-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Hardware Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force]


hw-disk-unmark-spare

Unmarks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached. 

 qs hw-disk-unmark-spare|hwd-unmark-spare --disk-list=value --controller=value [--flags=value ]
  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, forget-missing, min, *none]


hw-enclosure-get

Returns information about a specific enclosure managed by the specified Hardware Controller. 

 qs hw-enclosure-get|hwe-get --enclosure=value [--flags=value ]
  enclosure Name of a hardware RAID enclosure or it unique ID.
  flags Optional flags for the command. [force, min]


hw-enclosure-layout-get

Returns information about a specific enclosure layout managed by the current system. 

 qs hw-enclosure-layout-get|hwe-layout-get --hw-enclosure-layout=value [--flags=value ]
  hw-enclosure-layout Name of the hardware RAID enclosure layout or its unique ID
  flags Optional flags for the operation. [force, min]


hw-enclosure-layout-list

Returns a list of all the enclosure layouts managed by the current system. 

 qs hw-enclosure-layout-list|hwe-layout-list [--flags=value ]
  flags Optional flags for the operation. [min]


hw-enclosure-layout-vendor-group-get

Returns information about a specific enclosure layout vendor group managed by the current system. 

 qs hw-enclosure-layout-vendor-group-get|hwe-layout-vg-get --hw-enclosure-layout-vendor-group=value [--flags=value ]
  hw-enclosure-layout-vendor-group Name of the hardware RAID enclosure layout vendor group or its unique ID
  flags Optional flags for the operation. [force, min]


hw-enclosure-layout-vendor-group-list

Returns a list of all the enclosure layout vendor groups managed by the current system. 

 qs hw-enclosure-layout-vendor-group-list|hwe-layout-vg-list [--flags=value ]
  flags Optional flags for the operation. [min]


hw-enclosure-list

Returns a list of all the enclosures managed by the specified Hardware Controller. 

 qs hw-enclosure-list|hwe-list [--controller=value ] [--normalize=value ] [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  normalize Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
  flags Optional flags for the command. [min]


hw-enclosure-modify

Modifies the properties of a specific enclosure managed by the specified Hardware Controller. 

 qs hw-enclosure-modify|hwe-modify --enclosure=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--chassis-tag=value ] [--flags=value ]
  enclosure Name of a hardware RAID enclosure or it unique ID.
  alt-name Alternate name for an enclosure within a hardware controller.
  description Description for an enclosure within a hardware controller.
  enclosure-layout Enclosure layout for an enclosure within a hardware controller.
  chassis-tag Name of a chassis tag for sorting hardware disks within hardware enclosures.
  flags Optional flags for the command. [async]


hw-enclosure-search

Returns a subset of HW Enclosure objects matching the given criteria. 

 qs hw-enclosure-search|hwe-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Hardware Enclosure List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force]


hw-enclosure-slot-identify

Flashes the LED indicator light on the specified slots in the RAID enclosure so that they can be identified in the enclosure. 

 qs hw-enclosure-slot-identify|hwe-slot-identify --enclosure=value [--slot-list=value ] [--blink-type=value ] [--duration=value ] [--all-slots=value ] [--flags=value ]
  enclosure Name of a hardware RAID enclosure or it unique ID.
  slot-list List of the enclosure's slots to be identified/blinked.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  all-slots Perform action on all slots in the enclosure.
  flags Optional flags for the operation. [async]


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-level=value [--disks-per-unit=value ] [--disk-category=value ] [--min-size=value ] [--max-size=value ] [--unit-count=value ] [--options=value ] [--storage-system=value ] [--controller=value ] [--flags=value ]
  raid-level Hardware RAID type for a hardware RAID unit. [*RAID0, RAID1, RAID5, RAID6]
  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, RAID0 default = 1.
  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.
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the operation. [async, force, forget-missing, 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, forget-missing, 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 ] [--flags=value ]
  unit Name of a hardware RAID unit or it unique ID.
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-unit-encrypt

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

 qs hw-unit-encrypt|hwu-encrypt --unit=value [--options=value ] [--flags=value ]
  unit Name of a hardware RAID unit or it unique ID.
  options Special options to hardware encryption policy.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


hw-unit-get

Returns information about a specific RAID unit managed by the specified Hardware Controller. 

 qs hw-unit-get|hwu-get --unit=value [--flags=value ]
  unit Name of a hardware RAID unit or it unique ID.
  flags Optional flags for the command. [force, min]


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 [--blink-type=value ] [--duration=value ] [--flags=value ]
  unit Name of a hardware RAID unit or it unique ID.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--flags=value ]
  controller Name or ID of a hardware RAID controller.
  flags Optional flags for the command. [min]


hw-unit-search

Returns a subset of HW Unit objects matching the given criteria. 

 qs hw-unit-search|hwu-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Hardware Unit List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force]

Key Server Profile Management [KEY-SERVER-PROFILE]

Key Server Profiles contain all of the neccessary certificate and connection information needed for KMIP operations.

key-server-profile-create

Creates a key server profile. 

 qs key-server-profile-create|ksp-create --name=value --server-type=value --username=value --password=value --ca-cert=value --client-cert=value --client-key=value --host=value --kmip-connection-port=value --protocol=value --connection-mode=value --timeout=value [--description=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  server-type Specifies the type of KMIP compatable server is being used. [*default, ibm, kmip]
  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.
  ca-cert The file location of the Certification Authority Certificate in x509 certificate format.
  client-cert The file location of the Client Certificate in x509 certificate format.
  client-key The file location of the Client Private Key in RSA private key format.
  host Name of the host or its unique ID (GUID).
  kmip-connection-port The port number for which to estabilish a connection with the KIMP server host.
  protocol Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
  connection-mode Connection mode for the server. [reconnect, *reset]
  timeout Timeout value for client-server KMIP operations (default: 10 sec).
  flags Optional flags for the operation. [min]


key-server-profile-delete

Deletes the specified key server profile. 

 qs key-server-profile-delete|ksp-delete --key-server-profile=value [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  flags Optional flags for the operation. [min]


key-server-profile-get

Returns the key information for the specified key. 

 qs key-server-profile-get|ksp-get --key-server-profile=value [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  flags Optional flags for the operation. [min]


key-server-profile-key-add

Registers a key to the integrated key server. 

 qs key-server-profile-key-add|ksp-key-add --key-server-profile=value --key-data=value --encoding=value --key-type=value --resource-type=value [--name=value ] [--description=value ] [--resource-id=value ] [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  key-data Data payload for the key object being stored on the key server.
  encoding Data encoding for object stored on the key server. [*none]
  key-type Key type sent in KMIP payload. [*all-key, data-encryption-key, root-key]
  resource-id GUID for the resource the key is associated with. Required if '--resource-type' is 'storage-pool' or 'ceph-cluster'.
  resource-type An enum to identify the type of resource the key is associated with. [none*,storage-pool,ceph-cluster] [ceph-cluster, *none, storage-pool]
  flags Optional flags for the operation. [min]


key-server-profile-key-modify

Modifies the name and description for a KMIP key. 

 qs key-server-profile-key-modify|ksp-key-modify [--key-server-profile=value ] [--name=value ] [--description=value ] [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  flags Optional flags for the operation. [min]


key-server-profile-key-remove

Deletes the specified key from the key server. 

 qs key-server-profile-key-remove|ksp-key-remove --key-server-profile=value --name=value [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  flags Optional flags for the operation. [min]


key-server-profile-list

Returns a list of all server profiles. 

 qs key-server-profile-list|ksp-list [--flags=value ]
  flags Optional flags for the operation. [min]


key-server-profile-modify

Modifies the properties of a key server profile object. 

 qs key-server-profile-modify|ksp-modify --key-server-profile=value [--name=value ] [--description=value ] [--server-type=value ] [--username=value ] [--password=value ] [--ca-cert=value ] [--client-cert=value ] [--client-key=value ] [--host=value ] [--kmip-connection-port=value ] [--protocol=value ] [--connection-mode=value ] [--timeout=value ] [--flags=value ]
  key-server-profile Unique identifier (GUID) for the object.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  server-type Specifies the type of KMIP compatable server is being used. [*default, ibm, kmip]
  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.
  ca-cert The file location of the Certification Authority Certificate in x509 certificate format.
  client-cert The file location of the Client Certificate in x509 certificate format.
  client-key The file location of the Client Private Key in RSA private key format.
  host Name of the host or its unique ID (GUID).
  kmip-connection-port The port number for which to estabilish a connection with the KIMP server host.
  protocol Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
  connection-mode Connection mode for the server. [reconnect, *reset]
  timeout Timeout value for client-server KMIP operations (default: 10 sec).
  flags Optional flags for the operation. [min]

Key Server Profile Key Management [KEY-SERVER-PROFILE-KEY]

Key object to key server profiles.

key-server-profile-key-get

Gets the info of specified key that is on the given key server profile. 

 qs key-server-profile-key-get|ksp-key-get --key=value [--flags=value ]
  key Identifier for KMIP key.
  flags Optional flags for the operation. [min]


key-server-profile-key-list

Lists the key associations from the specified key server profile. 

 qs key-server-profile-key-list|ksp-key-list [--key-server-profile=value ] [--flags=value ]
  key-server-profile Identifier for Key Server Profile.
  flags Optional flags for the operation. [min]

License Management [LICENSE]

Commands for management of Storage System license keys including adding, removing and listing License Keys.

license-activate

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

 qs license-activate|lic-act --activation-key=value [--flags=value ]
  activation-key Activation key you'll receive from customer support after you send the activation request code.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


license-activate-online

Requests automatic activation via the online activation service. 

 qs license-activate-online|lic-aon [--key=value ] [--renew-lease=value ] [--flags=value ]
  key Unique license key identifier, use license-list to get a list of these.
  renew-lease Does a lease renewal of the license, only applies to Cloud Edition keys which require lease renewal.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


license-get

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

 qs license-get|lic-get --key=value [--flags=value ]
  key Unique license key identifier, use license-list to get a list of these.
  flags Optional flags for the command. [force, min]


license-list

Returns a list of all the registered license keys. 

 qs license-list|lic-list [--flags=value ]
  flags Optional flags for the command. [min]


license-modify-support

Applies reseller and support contract information to the license key. This information is also written to /var/opt/osnexus/quantastor/support.info for support log collection. 

 qs license-modify-support|lic-modify-support --key=value [--reseller-name=value ] [--reseller-contact-number=value ] [--reseller-email=value ] [--support-contract-number=value ] [--flags=value ]
  key Unique license key identifier, use license-list to get a list of these.
  reseller-name Full name of the reseller technical support contact.
  reseller-contact-number Phone number of the reseller technical support contact.
  reseller-email Email address of the reseller technical support contact.
  support-contract-number Reseller support contract reference number.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


license-remove

Removes the specified license key. 

 qs license-remove|lic-remove --key=value [--flags=value ]
  key Unique license key identifier, use license-list to get a list of these.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Maintenance Schedule Management [MAINTENANCE-SCHEDULE]

Operations for scheduling of Storage Pool maintenance such as scrub and SSD TRIM operations.

maintenance-schedule-add

Adds Storage Pools to the specified Maintenance Schedule. 

 qs maintenance-schedule-add|maintenance-sch-add --maintenance-schedule=value --pool-list=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]


maintenance-schedule-assoc-get

Returns details of a specific Maintenance Schedule association to a Storage Pool. 

 qs maintenance-schedule-assoc-get|maintenance-sch-assoc-get --maintenance-schedule=value --pool=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the command. [min]


maintenance-schedule-assoc-list

Returns a list of all the Maintenance Schedule associations to Storage Pools 

 qs maintenance-schedule-assoc-list|maintenance-sch-assoc-list --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [min]


maintenance-schedule-create

Creates a new Maintenance Schedule to periodically run bit-rot scrubs on Storage Pools to ensure data integrity. 

 qs maintenance-schedule-create|maintenance-sch-create --name=value [--maintenance-type=value ] [--description=value ] [--pool-list=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  maintenance-type Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
  description Description for an enclosure within a hardware controller.
  pool-list List of one or more storage pools.
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  start-date 2016-12-29T00:00:00Z)
  min-days-between-maint Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
  days The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
  hours Maintenance schedule must start on the specified hour. [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. [min]


maintenance-schedule-delete

Deletes the specified Maintenance Schedule. 

 qs maintenance-schedule-delete|maintenance-sch-delete --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [min]


maintenance-schedule-disable

Disables the specified Maintenance Schedule. 

 qs maintenance-schedule-disable|maintenance-sch-disable --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [min]


maintenance-schedule-enable

Enables the specified Maintenance Schedule. 

 qs maintenance-schedule-enable|maintenance-sch-enable --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [min]


maintenance-schedule-get

Gets detailed properties of a specific Maintenance Schedule. 

 qs maintenance-schedule-get|maintenance-sch-get --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [force, min]


maintenance-schedule-list

Returns a list of all the Maintenance Schedules. 

 qs maintenance-schedule-list|maintenance-sch-list [--flags=value ]
  flags Optional flags for the operation. [min]


maintenance-schedule-modify

Used to modify the properties of a Maintenance Schedule including name and description. 

 qs maintenance-schedule-modify|maintenance-sch-modify --maintenance-schedule=value [--name=value ] [--description=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--maintenance-type=value ] [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  start-date 2016-12-29T00:00:00Z)
  min-days-between-maint Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
  days The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
  hours Maintenance schedule must start on the specified hour. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
  maintenance-type Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket. [*pool-scrub, pool-trim, s3-orphan-cleanup]
  flags Optional flags for the operation. [min]


maintenance-schedule-remove

Removes Storage Pools from the specified Maintenance Schedule. 

 qs maintenance-schedule-remove|maintenance-sch-remove --maintenance-schedule=value --pool-list=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]


maintenance-schedule-trigger

Starts the specified Maintenance Schedule immediately. 

 qs maintenance-schedule-trigger|maintenance-sch-trigger --maintenance-schedule=value [--flags=value ]
  maintenance-schedule A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
  flags Optional flags for the operation. [min]

Multi-Factor Authentication Configuration Management [MULTIFACTORAUTHCONFIG]

Multi-factor authentication configurations are required for enabling multi-factor authentication at login time for users.

multi-factor-auth-config-create

Creates a multi-factor authentication configuration including API host, integration key, and secrety key to enable multi-factor authentication. 

 qs multi-factor-auth-config-create|mfa-config-create --api-host=value --integration-key=value --secret-key=value --name=value [--description=value ] [--flags=value ]
  api-host API host for DUO multi-factor authentication
  integration-key Integration key for DUO multi-factor authentication
  secret-key secret-key
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for the multi-factor authentication configuration.
  flags Optional flags for the operation. [min]


multi-factor-auth-config-delete

Deletes the multi-factor authentication configuration and removes it from all users which are currently using the specified configuration. 

 qs multi-factor-auth-config-delete|mfa-config-delete --mfa-config-list=value [--flags=value ]
  mfa-config-list mfa-config-list
  flags Optional flags for the operation. [min]


multi-factor-auth-config-get

Gets information about the specified multi-factor authentication configuration. 

 qs multi-factor-auth-config-get|mfa-config-get --mfa-config=value [--flags=value ]
  mfa-config Name or ID of a multi-factor authentication configuration.
  flags Optional flags for the operation. [force, min]


multi-factor-auth-config-list

Lists all multi-factor authentication configurations. 

 qs multi-factor-auth-config-list|mfa-config-list [--flags=value ]
  flags Optional flags for the operation. [min]


multi-factor-auth-config-modify

Modifies the properties of the multi-factor authentication configuration such as its name and description. 

 qs multi-factor-auth-config-modify|mfa-config-modify --mfa-config=value [--secret-key=value ] [--name=value ] [--desc=value ] [--flags=value ]
  mfa-config Name or ID of a multi-factor authentication configuration.
  secret-key Secret key for DUO multi-factor authentication
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  flags Optional flags for the operation. [min]


multi-factor-auth-config-set-user

Adds or removes multi-factor authentication configurations specified as 'user1=config1,user2=config2,~user3,...', prepend with tilde (~) to remove multi-factor authentication configurations from specified users. 

 qs multi-factor-auth-config-set-user|mfa-config-set-user --user-config-assignments=value [--flags=value ]
  user-config-assignments User to multi-factor authentication configuration assignments specified as 'user1:config1,user2:config2,~user3,...' prepend with tilde (~) to remove configurations.
  flags Optional flags for the operation. [min]

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 --share-list=value --preferred-ports=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.
  share-list A list of one or more Network Shares.
  preferred-ports List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


share-namespace-create

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

 qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--dfs-mode=value ] [--nfs-mode=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  dfs-mode dfs-mode [disabled, *flat, grouped]
  nfs-mode nfs-mode [disabled, *flat]
  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 [--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 command. [min]


share-namespace-list

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

 qs share-namespace-list|nspc-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--dfs-mode=value ] [--nfs-mode=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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  dfs-mode dfs-mode [disabled, *flat, grouped]
  nfs-mode nfs-mode [disabled, *flat]
  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 [--share-list=value ] [--preferred-ports=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.
  share-list A list of one or more Network Shares.
  preferred-ports List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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

pool-add-dedup-offload

Adds a pair of mirrored dedicated deduplication metadata offload devices to the specified storage pool. 

 qs pool-add-dedup-offload|p-add-dedup-offload --pool=value --disk-list=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async]


pool-add-metadata-offload

Adds a pair of mirrored dedicated metadata offload devices to the specified storage pool. 

 qs pool-add-metadata-offload|p-add-metadata-offload --pool=value --disk-list=value [--small-block-threshold=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  small-block-threshold Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
  flags Optional flags for the operation. [async]


pool-add-read-cache

Adds a dedicated read cache to the specified storage pool. 

 qs pool-add-read-cache|p-add-read-cache --pool=value --disk-list=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async]


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 (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async]


pool-add-write-log

Adds a dedicated write log to the specified storage pool. 

 qs pool-add-write-log|p-add-write-log --pool=value --disk-list=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  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 ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--key-server-type=value ] [--key-server-profile=value ] [--ashift=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters, special characters (-_.) excluding the parentheses. Size ranging from 2 to 40 characters.
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  raid-type RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
  pool-type The type of storage pool to be created. [swap, *zfs]
  desc A description for the object.
  is-default Indicates that this pool should be utilized as the default storage pool.
  compress Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
  auto-trim Enable auto-trim storage pool optimizations.
  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 Number of disks to use in each set of disks (aka VDEV) when creating a new storage pool with layout RAID10, RAIDZ1/50, RAIDZ2/60, or RAIDZ3.
  encrypt Enables encryption on all devices in the storage pool or other storage resource. Encryption can only be enabled at the time of storage resource creation.
  encryption-type Sets the encryption algorithm, currently only the default aes256 is supported. [SED, 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.
  key-server-type Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
  key-server-profile Identifier for Key Server Profile.
  ashift Controls the block size offset for the devices which can impact usable capacity and performance. Recommend leaving this at 0 so that the system can automatically select based on the reported blocksize of the devices.
  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-keys=value ] [--shred-mode=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  shred-keys Shreds the keys if the pool is an encrypted Storage Pool.
  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 --pool-device=value [--flags=value ]
  pool-device Name or UUID of a storage pool device
  flags Optional flags for the command. [force, min]


pool-device-group-get

Gets information about a specific storage pool device group. 

 qs pool-device-group-get|spdg-get --pool-device-group=value [--flags=value ]
  pool-device-group Name or UUID of a storage pool device group
  flags Optional flags for the command. [force, min]


pool-device-group-identify

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

 qs pool-device-group-identify|spdg-ident --pool-device-group=value [--duration=value ] [--blink-type=value ] [--flags=value ]
  pool-device-group Name or UUID of a storage pool device group
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  flags Optional flags for the operation. [async]


pool-device-group-list

Returns a list of all the storage pool device groups. 

 qs pool-device-group-list|spdg-list [--pool=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the command. [min]


pool-device-group-search

Returns a subset of Storage Pool Device Group objects matching the given search criteria. 

 qs pool-device-group-search|spdg-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Storage Pool Device Group List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


pool-device-list

Returns a list of all the storage pool devices. 

 qs pool-device-list|spd-list [--pool=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the command. [min]


pool-device-search

Returns a subset of Storage Pool Device objects matching the given search criteria. 

 qs pool-device-search|spd-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Storage Pool Device List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--release-io-fence=value ] [--metadata-only=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  release-io-fence Release all I/O fence reservations for the specified disk(s)
  metadata-only Export a new metadata archive to the '.poolmeta' directory for the specified pool. The pool is not exported, rather this option provides for a way to make a new explicit backup of pool metadata.
  flags Optional flags for the operation. [async]


pool-get

Gets information about a specific storage pool. 

 qs pool-get|p-get --pool=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the operation. [force, forget-missing, min]


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 (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  raid-type RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
  flags Optional flags for the operation. [async]


pool-health-check

Checks the health/state of the pool and recursively checks the health of the associated disk devices to see if there are any issues anywhere in the stack. 

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


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 [--blink-type=value ] [--duration=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  blink-type Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
  duration Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specifies delay until OFF action is taken.
  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 --pool-list=value [--storage-system=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ]
  pool-list List of storage pools.
  storage-system Name or ID of a Storage System in a management grid.
  metadata-only Import only the metadata archive from the '.poolmeta' directory for the specified pool. Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
  skip-metadata Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory. Useful for when the metadata is too old or invalid.
  flags Optional flags for the operation. [async]


pool-import-encrypted

Imports the named encrypted storage pool(s) which have been previously exported, providing the given passphrase to decrypt the pool. 

 qs pool-import-encrypted|p-import-crypt --storage-system=value --pool-list=value [--passphrase=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  pool-list List of storage pools.
  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.
  metadata-only Import only the metadata archive from the '.poolmeta' directory for the specified pool. Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
  skip-metadata Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory. Useful for when the metadata is too old or invalid.
  flags Optional flags for the operation. [async]


pool-key-export

Exports all the encryption key information for the specified Storage Pool into a block that can be used in the future to re-import the keys. 

 qs pool-key-export|p-key-export --pool=value --key-file=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  key-file File name to use for the exported pool key block.
  flags Optional flags for the operation. [min]


pool-key-import

Import the previously exported encryption keys for a Storage Pool to the specified Storage System. 

 qs pool-key-import|p-key-import --key-file=value [--storage-system=value ] [--flags=value ]
  key-file File which contains the previously exported key block to use for importing.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [min]


pool-list

Returns a list of all the storage pools. 

 qs pool-list|p-list [--vasa-support-only=value ] [--flags=value ]
  vasa-support-only VASA support only.
  flags Optional flags for the command. [min]


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 ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--desc=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--repair-policy=value ] [--approve-repair=value ] [--copies=value ] [--key-server-profile=value ] [--key-server-type=value ] [--small-block-threshold=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  is-default Indicates that this pool should be utilized as the default storage pool.
  compress Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
  auto-trim Enable auto-trim storage pool optimizations.
  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]
  primarycache Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
  secondarycache Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
  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).
  key-server-profile Identifier for Key Server Profile.
  key-server-type Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
  small-block-threshold Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
  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 [--flags=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.
  flags Optional flags for the command. [force, min]


pool-profile-list

Returns a list of all the storage pool profiles. 

 qs pool-profile-list|pp-list [--flags=value ]
  flags Optional flags for the command. [min]


pool-rekey

Add a new key to availible LUKS key slot. Creates a back up of valid previously used key and generates key materials for the new key. 

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


pool-remove-read-cache

Removes the specified read cache from the specified pool. 

 qs pool-remove-read-cache|p-remove-read-cache --pool=value --disk-list=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async]


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 (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  flags Optional flags for the operation. [async]


pool-remove-write-log

Removes the specified write log from the specified pool. 

 qs pool-remove-write-log|p-remove-write-log --pool=value --disk-list=value [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  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 'zpool scrub' 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-search

Returns a subset of Storage Pools matching the given search criteria. 

 qs pool-search|p-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Storage Pool List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


pool-set-passphrase

Sets or clears the encryption passphrase for an encrypted storage pool. 

 qs pool-set-passphrase|p-set-passphrase --pool=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ]
  pool Name of the storage pool or its unique ID (GUID).
  current-passphrase Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
  new-passphrase New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
  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]


pool-trim

Starts a trim operation on a ZFS-based Storage Pool. See 'zpool trim' command for additional control. 

 qs pool-trim|p-trim --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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 [--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 command. [force, min]


qos-policy-list

Returns details on the list of all QoS policy objects in the Storage System grid. 

 qs qos-policy-list|qos-list [--flags=value ]
  flags Optional flags for the command. [min]


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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 --resource-group=value [--policy=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  pool Name of the storage pool or its unique ID (GUID).
  resource-group Name of a Resource Group 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 [--flags=value ]
  quota Name or ID of a storage provisioning quota.
  flags Optional flags for the command. [force, min]


provisioning-quota-list

Returns a list of all the storage provisioning quotas. 

 qs provisioning-quota-list|pq-list [--flags=value ]
  flags Optional flags for the command. [min]


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 --resource-group=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.
  resource-group Name of a Resource Group or its unique id.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 [--flags=value ]
  quota Name or ID of a storage provisioning quota.
  share-list A list of one or more Network Shares.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  share Name or ID of a Network Share.
  flags Optional flags for the command. [min]


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 [--flags=value ]
  quota Name or ID of a storage provisioning quota.
  share-list A list of one or more Network Shares.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  quota Name or ID of a storage provisioning quota.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  flags Optional flags for the command. [min]


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 [--flags=value ]
  quota Name or ID of a storage provisioning quota.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 [--flags=value ]
  replica-assoc Name or ID of a replica association between a source/target volume or share
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


replica-assoc-get

Returns details of the specified replication association. 

 qs replica-assoc-get|rep-assoc-get --replica-assoc=value [--flags=value ]
  replica-assoc Name or ID of a replica association between a source/target volume or share
  flags Optional flags for the command. [force, min]


replica-assoc-list

Returns a list of all the replication associations. 

 qs replica-assoc-list|rep-assoc-list [--flags=value ]
  flags Optional flags for the command. [min]


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 [--flags=value ]
  replica-assoc Name or ID of a replica association between a source/target volume or share
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  replica-assoc Name or ID of a replica association between a source/target volume or share
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  replica-assoc Name or ID of a replica association between a source/target volume or share
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


replica-report-entry-get

Get a replication report entry. 

 qs replica-report-entry-get|rep-report-get --report-entry=value [--flags=value ]
  report-entry Name or ID of the replication report entry
  flags Optional flags for the command. [min]


replica-report-entry-list

Returns a list of replication report entry. 

 qs replica-report-entry-list|rep-report-list [--report-summary=value ] [--flags=value ]
  report-summary Name or ID of the replication report summary
  flags Optional flags for the command. [min]


replica-report-summary-delete

Delete a replication report summary. All the report entries for this summary will be deleted. 

 qs replica-report-summary-delete|rep-report-summary-delete --report-summary=value [--flags=value ]
  report-summary Name or ID of the replication report summary
  flags Optional flags for the command. [min]


replica-report-summary-get

Get a replication report summary. 

 qs replica-report-summary-get|rep-report-summary-get --report-summary=value [--flags=value ]
  report-summary Name or ID of the replication report summary
  flags Optional flags for the command. [min]


replica-report-summary-list

Returns a list of replication report summary. 

 qs replica-report-summary-list|rep-report-summary-list [--schedule=value ] [--flags=value ]
  schedule Name or ID of a replication schedule.
  flags Optional flags for the command. [min]


replication-schedule-activate-checkpoints

Activates all the Network Shares and Storage Volumes associated with the schedule as 'active replica checkpoints'. This stops the schedule from running and makes it clear to the user (see green dot in WUI and isActiveCheckpoint) that the share/volume is in use by the DR site. Optionally a subset of volumes/shares may be selected to be activated. Note also that SMB/NFS/iSCSI/FC login to a given _chkpnt marked share or volume will automatically transition it to the Active Checkpoint state. This Active Checkpoint state must be cleared for all shares/volumes in a given Replication Schedule before the schedule can resume automatic replication. 

 qs replication-schedule-activate-checkpoints|rsch-act-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--auto-alias=value ] [--flags=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.
  auto-alias Creates Network Share aliases for all of the Network Share checkpoints so that they may be accessed using the name of the source Network Share rather than a share with the _chkpnt suffix.
  flags Optional flags for the operation. [async]


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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  resource-group Name of a Resource Group 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.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  rc-src-hourly Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-src-dailies Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-src-weeklies Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-src-monthlies Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-src-quarterlies Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  rc-dst-hourly Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dst-dailies Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
  rc-dst-weeklies Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
  rc-dst-monthlies Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
  rc-dst-quarterlies Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
  flags Optional flags for the operation. [async]
  reuse-source-snapshot Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
  reuse-target-chkpnt Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
  rc-summary-reports Number of replication summary reports to retain.
  include-nested-shares Include nested shares.
  resumable-replication Enable resumable replication. Defaults to true.


replication-schedule-deactivate-checkpoints

Deactivates all the Network Shares and Storage Volumes associated with the schedule so that the schedule can resume automatic replication. If there are active sessions to any Volumes/Shares the schedule will not be able to be re-enabled. 

 qs replication-schedule-deactivate-checkpoints|rsch-deact-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--reenable=value ] [--flags=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.
  reenable Re-enables the schedule so that automatic replication can resume.
  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 [--flags=value ]
  schedule Name or ID of a replication schedule.
  flags Optional flags for the command. [force, min]


replication-schedule-list

Returns a list of all the replication schedules. 

 qs replication-schedule-list|rsch-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ]
  schedule Name or ID of a replication schedule.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  resource-group Name of a Resource Group 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.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  rc-src-hourly Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-src-dailies Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-src-weeklies Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-src-monthlies Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-src-quarterlies Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  rc-dst-hourly Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dst-dailies Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
  rc-dst-weeklies Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
  rc-dst-monthlies Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
  rc-dst-quarterlies Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
  flags Optional flags for the operation. [async]
  reuse-source-snapshot Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
  reuse-target-chkpnt Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
  rc-summary-reports Number of replication summary reports to retain.
  include-nested-shares Include nested shares.
  resumable-replication Enable resumable replication. Defaults to true.


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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


replication-schedule-trigger

Triggers the specified schedule to run immediately. 

 qs replication-schedule-trigger|rsch-trigger --schedule=value [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--flags=value ]
  schedule Name or ID of a replication schedule.
  reuse-source-snapshot Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
  reuse-target-chkpnt Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
  flags Optional flags for the operation. [async, force]

Report Schedule Management [REPORT-SCHEDULE]

Operations for sending automatic email reports on a schedule.

report-schedule-add-pool

Adds pools to the Report Schedule for usage and capacity reports. 

 qs report-schedule-add-pool|rs-add-pool --report-schedule=value --pool-list=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]


report-schedule-assoc-get

Gets detailed information on a specific Report Schedule Association 

 qs report-schedule-assoc-get|rs-assoc-get --report-schedule=value --pool=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  pool Name of the storage pool or its unique ID (GUID).
  flags Optional flags for the command. [min]


report-schedule-assoc-list

Returns a list of all the Report Schedule associations to Pools 

 qs report-schedule-assoc-list|rs-assoc-list --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [min]


report-schedule-create

Creates a new Report Schedule 

 qs report-schedule-create|rs-create --name=value [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--pool-list=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  report-email Email address to send the report to.
  report-to-alert-emails Sends the report to the users and email addresses already configured to receive system alerts.
  report-types Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
  output-format Output format of the data to be written [csv, html, *text]
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  start-date 2016-12-29T00:00:00Z)
  interval-days Delay interval in days between when a schedule run completes and the next one is started.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  max-depth If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
  max-subdirs Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
  min-used Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
  pool-list List of one or more storage pools.
  max-buckets Maximum buckets to be included in the report for each tenant
  max-users Maximum users to be included in report for each tenant.
  min-user-space-utilized Minimum space utilized by a user to be included in the report.
  min-bucket-space-utilized Minimum utilized space of the bucket to be included in the report.
  flags Optional flags for the operation. [force, min]


report-schedule-delete

Deletes the specified Report Schedule 

 qs report-schedule-delete|rs-delete --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [min]


report-schedule-disable

Disables the specified Report Schedule 

 qs report-schedule-disable|rs-disable --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [min]


report-schedule-enable

Enables the specified Report Schedule 

 qs report-schedule-enable|rs-enable --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [min]


report-schedule-get

Returns details of a specific Report Schedule 

 qs report-schedule-get|rs-get --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [force, min]


report-schedule-list

Returns a list of all the Report Schedules 

 qs report-schedule-list|rs-list [--flags=value ]
  flags Optional flags for the operation. [min]


report-schedule-modify

Modifies the specified Report Schedule 

 qs report-schedule-modify|rs-modify --report-schedule=value [--name=value ] [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  description Description for an enclosure within a hardware controller.
  report-email Email address to send the report to.
  report-to-alert-emails Sends the report to the users and email addresses already configured to receive system alerts.
  report-types Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
  output-format Output format of the data to be written [csv, html, *text]
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  start-date 2016-12-29T00:00:00Z)
  interval-days Delay interval in days between when a schedule run completes and the next one is started.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  max-depth If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
  max-subdirs Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
  min-used Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
  max-buckets Maximum buckets to be included in the report for each tenant
  max-users Maximum users to be included in report for each tenant.
  min-user-space-utilized Minimum space utilized by a user to be included in the report.
  min-bucket-space-utilized Minimum utilized space of the bucket to be included in the report.
  flags Optional flags for the operation. [min]


report-schedule-remove-pool

Removes pools from the Report Schedule for usage and capacity reports. 

 qs report-schedule-remove-pool|rs-remove-pool --report-schedule=value --pool-list=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  pool-list List of one or more storage pools.
  flags Optional flags for the operation. [min]


report-schedule-trigger

Triggers the specified Report Schedule to immediately send a report. 

 qs report-schedule-trigger|rs-trigger --report-schedule=value [--flags=value ]
  report-schedule Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
  flags Optional flags for the operation. [min]


system-report

Generate a configuration analysis health report of all Storage Systems in the grid. 

 qs system-report|sys-report [--report-type=value ] [--config-category=value ] [--output-format=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ]
  report-type Type of report to generate. [capacity, health, *none, objectusage, replication, usage]
  config-category Category of commands to get help with (all, network, HA, remote-replication, ceph, zfs, cephfs, HA-cluster, grid, security, general, hw-maint). [*ALL, HA, hw-maint, network, platform, remote-replication, security]
  output-format Output format of the data to be written [csv, html, *text]
  report-email Email address to send the report to.
  report-to-alert-emails Sends the report to the users and email addresses already configured to receive system alerts.
  max-depth If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
  max-subdirs Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
  min-used Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
  max-buckets Maximum buckets to be included in the report for each tenant
  max-users Maximum users to be included in report for each tenant.
  min-user-space-utilized Minimum space utilized by a user to be included in the report.
  min-bucket-space-utilized Minimum utilized space of the bucket to be included in the report.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]

Resource Domain Management [RESOURCE-DOMAIN]

Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH) 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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--flags=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.
  flags Optional flags for the command. [min]


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 [--flags=value ]
  flags Optional flags for the command. [min]


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-domain-type=value ] [--resource-parent=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  resource-domain-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 [--flags=value ]
  domain-resource ID or name of a domain resource.
  flags Optional flags for the command. [min]


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 [--flags=value ]
  flags Optional flags for the command. [min]


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-domain-type=value ] [--resource-parent=value ] [--flags=value ]
  domain-resource ID or name of a domain resource.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  resource-domain-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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 --network-list=value [--desc=value ] [--subject-list=value ] [--resource-list=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--scope=value ] [--scope-type=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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...
  network-list A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
  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.
  scope Scope for the Resource Group
  scope-type Scope type for the Resource Group [Ceph, HA, *local]
  flags Optional flags for the operation. [async, force, forget-missing, 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 --resource-group=value [--flags=value ]
  resource-group Name of a Resource Group 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 --resource-group=value [--flags=value ]
  resource-group Name of a Resource Group 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 --resource-group=value [--name=value ] [--desc=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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, forget-missing, min, *none]


resource-group-network-add

Add one or more network access points to the specified tenant resource group 

 qs resource-group-network-add|rg-net-add --resource-group=value --network-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  network-list A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-network-enum

Returns list of all resource group network access bindings. 

 qs resource-group-network-enum|rg-net-enum [--flags=value ]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-network-get

Returns specified resource group network access binding. 

 qs resource-group-network-get|rg-net-get --resource-group=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-network-remove

Remove one or more network access points from the specified tenant resource group 

 qs resource-group-network-remove|rg-net-remove --resource-group=value --network-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  network-list A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-resource-add

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

 qs resource-group-resource-add|rg-res-add --resource-group=value --resource-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-resource-mode

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

 qs resource-group-resource-mode|rg-res-mode --resource-group=value --resource=value --access-mode=value [--flags=value ]
  resource-group Name of a Resource Group 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, forget-missing, min, *none]


resource-group-resource-remove

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

 qs resource-group-resource-remove|rg-res-remove --resource-group=value --resource-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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|rg-user-list --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|rg-user-add --resource-group=value --subject-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


resource-group-user-remove

Remove one or more users from specified tenant resource group. 

 qs resource-group-user-remove|rg-user-remove --resource-group=value --subject-list=value [--flags=value ]
  resource-group Name of a Resource Group or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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

login-precheck

Returns basic service startup information usable before attempting login or commands. 

 qs login-precheck|lpc [--flags=value ]
  flags Optional flags for the command. [min]


password-policy-get

Returns details of the current user password policy settings for the storage grid / appliances. 

 qs password-policy-get|pw-policy-get [--flags=value ]
  flags Optional flags for the command. [min]


password-policy-set

Configures the password policy requirements for user accounts. 

 qs password-policy-set|pw-policy-set [--special-chars=value ] [--complexity=value ] [--min-length=value ] [--max-length=value ] [--login-attempts-short-lockout=value ] [--login-attempts-perm-lockout=value ] [--short-lockout-sample-sec=value ] [--perm-lockout-sample-sec=value ] [--short-lockout-duration=value ] [--days-until-exp=value ] [--unique-pw-reuse=value ] [--min-days-between-change=value ] [--inactive-days-lockout=value ] [--web-logout-timeout=value ] [--use-note=value ] [--web-access=value ] [--default-login-username=value ] [--flags=value ]
  special-chars Special characters which are allowed to be used in a password.
  complexity Password complexity requirement where 'strong' requires a mix of numbers, letters, and special characters. [standard, strong, *weak]
  min-length Minimum password length (default 8)
  max-length Maximum password length (default 40)
  login-attempts-short-lockout Maximum password attempts before account is locked out for a short period. (default 5)
  login-attempts-perm-lockout Maximum password attempts before account is locked out and must be unlocked by an administrator. (default 0/disabled)
  short-lockout-sample-sec Continuous sample period (in seconds) over which bad login attempts are summed to determine if a short lockout to a User account should be applied.
  perm-lockout-sample-sec Continuous sample period (in seconds) over which bad login attempts are summed to determine if a permanent lockout to a User account should be applied.
  short-lockout-duration Duration of the short lockout due to bad login attempts.
  days-until-exp Days until a user's password expires and must be changed. (default 0/disabled)
  unique-pw-reuse Number of unique passwords that must be used before it can be reused.
  min-days-between-change Minimum number of days before a password may be changed again.
  inactive-days-lockout After N many days without a successful login for a given account this policy will automatically lock the user account unless it is the admin account (default 0/disabled).
  web-logout-timeout After N many minutes of no activity in the web interface users will be logged out automatically. (default 30 minutes)
  use-note System use notification message is an administrator supplied message that is presented to the user immediately after login. System use notification messages are required in some corporate and government environments to meet compliance standards.
  web-access Unsecure HTTP access mode should be disabled or redirected to HTTPS in almost all configurations. [disable-http, *enable-http, redirect-http]
  default-login-username Default login username presented when logging in via the web management interface.
  flags Optional flags for the command. [min]


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 ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  permissions List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
  ldap-group LDAP group name associated with the role.
  disable-wui-tabs Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
  disable-wui-sections Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


role-get

Gets information about the specified role. 

 qs role-get|r-get --role=value [--export=value ] [--flags=value ]
  role Name of a security role or its unique ID (GUID).
  export Export the role in XML format for use in the security definition file.
  flags Optional flags for the operation. [force, min]


role-list

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

 qs role-list|r-list [--flags=value ]
  flags Optional flags for the operation. [min]


role-modify

Modifies the name and/or description of a role 

 qs role-modify|r-modify --role=value [--name=value ] [--desc=value ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ]
  role Name of a security role or its unique ID (GUID).
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  ldap-group LDAP group name associated with the role.
  disable-wui-tabs Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
  disable-wui-sections Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


role-permission-add

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

 qs role-permission-add|rp-add --role=value --permissions=value [--flags=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. Must be of the form 'object:operation:scope'.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  flags Optional flags for the command. [min]


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 [--flags=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. Must be of the form 'object:operation:scope'.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


role-remove

Removes the specified role identified by name or ID 

 qs role-remove|r-remove --role=value [--flags=value ]
  role Name of a security role or its unique ID (GUID).
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


single-sign-on-policy-get

Gets the Single Sign-on Policy 

 qs single-sign-on-policy-get|sso-policy-get [--flags=value ]
  flags Optional flags for the command. [min]


single-sign-on-policy-set

Sets the Single Sign-on Policy 

 qs single-sign-on-policy-set|sso-policy-set --enable-single-sign-on=value [--ldap-server-fqdn=value ] [--ldap-server-base-dn=value ] [--flags=value ]
  enable-single-sign-on Enable Single Sign-on
  ldap-server-fqdn Fully Qualified Domain Name (FQDN) of the LDAP server. Example ldapserver.example.com
  ldap-server-base-dn LDAP server base DN for users. Example dc=ldapserver,dc=example,dc=com
  flags Optional flags for the command. [min]

Commands for S3 object storage setup and S3 user management. [S3]

s3-object-pool-group-create

Creates a new S3 Object Storage Pool Group/Zone within the specified Ceph Cluster to enable S3 Object Storage capabilities. 

 qs s3-object-pool-group-create|zone-create [--ceph-cluster=value ] [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--scaling-factor=value ] [--auto-config-nfs=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  desc A description for the object.
  object-store-zone Ceph object storage zone. (Default: 'default')
  object-store-zone-group Ceph object storage zone group. (Default: 'default')
  pool-type Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
  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.
  k Data chunk (k) count for erasure coded Ceph Pool.
  m Check-sum (m) chunk count for erasure coded Ceph Pool.
  ec-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  scaling-factor Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
  auto-config-nfs Auto configure NFS services for scale-out storage.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-object-pool-group-create-storage-class

Creates a data pool for a Storage Class in the given Object Pool Group. 

 qs s3-object-pool-group-create-storage-class|zone-create-storage-class --ceph-object-pool-group=value --storage-class-name=value [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--ceph-cluster=value ] [--custom-storage-class-name=value ] [--flags=value ]
  ceph-object-pool-group Ceph object storage pool group.
  storage-class-name storage-class-name
  scaling-factor Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg S3/RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
  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 storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficent and is recommended for both scale-out file and object storage pools.
  k Data chunk (k) count for erasure coded Ceph Pool.
  m Check-sum (m) chunk count for erasure coded Ceph Pool.
  ec-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  custom-storage-class-name REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE ]
  flags Optional flags for the operation. [min]


s3-object-pool-group-delete

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

 qs s3-object-pool-group-delete|zone-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, forget-missing, min, *none]


s3-object-pool-group-get

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

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


s3-object-pool-group-list

Returns a list of all the object storage pool groups. 

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


s3-object-pool-group-modify

Modifies the settings for the object pool group. 

 qs s3-object-pool-group-modify|zone-modify --ceph-object-pool-group=value [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--flags=value ]
  ceph-object-pool-group Ceph object storage pool group.
  desc A description for the object.
  object-store-zone Ceph object storage zone. (Default: 'default')
  object-store-zone-group Ceph object storage zone group. (Default: 'default')
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-object-pool-group-multi-site-setup

Setup multi site S3 Object Zone 

 qs s3-object-pool-group-multi-site-setup|zone-multi-site-setup --primary-object-pool-group=value --secondary-object-pool-group=value --primary-rados-gateway=value --secondary-rados-gateway=value [--flags=value ]
  primary-object-pool-group Primary Object Storage Pool for Multi Site Setup
  secondary-object-pool-group Secondary Object Storage Pool Group for Multi Site Setup
  primary-rados-gateway Primary Rados Gateway for Multi Site Setup
  secondary-rados-gateway Secondary Rados Gateway for Multi Site Setup
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-object-pool-group-multi-site-unconfigure

Remove pool group from a multi site setup. 

 qs s3-object-pool-group-multi-site-unconfigure|zone-multi-site-unconfigure --ceph-object-pool-group=value [--flags=value ]
  ceph-object-pool-group Ceph object storage pool group.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-object-storage-class-get

Returns information about a specific object storage class used to store S3 object data. 

 qs s3-object-storage-class-get|osc-get --storage-class=value [--flags=value ]
  storage-class Ceph object storage-classes enable tagging of S3 objects to specific Ceph Pool(s).
  flags Optional flags for the operation. [force, min]


s3-object-storage-class-list

Returns a list of all the object storage class. 

 qs s3-object-storage-class-list|osc-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


s3-object-storage-class-rule-add

Adds Storage Class rules for dynamically auto-tiering S3 objects. 

 qs s3-object-storage-class-rule-add|oscr-add --rule-list=value [--ceph-cluster=value ] [--flags=value ]
  rule-list List of Storage Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


s3-object-storage-class-rule-get

Returns information about a specific object storage class rules used to store S3 object data in a specific Ceph Pool. 

 qs s3-object-storage-class-rule-get|oscr-get --storage-class-rule=value [--flags=value ]
  storage-class-rule Ceph object storage-class rules enables automatic tagging of objects to specific storage classes based on size and name match pattern.
  flags Optional flags for the operation. [force, min]


s3-object-storage-class-rule-list

Returns a list of all the object storage class rules. 

 qs s3-object-storage-class-rule-list|oscr-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


s3-object-storage-class-rule-remove

Removes specified Storage Class rules for dynamically auto-tiering S3 objects. 

 qs s3-object-storage-class-rule-remove|oscr-remove --rule-list=value [--ceph-cluster=value ] [--flags=value ]
  rule-list List of Storage Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


s3-object-zone-get

Returns information about a specific object zone used to store S3 object data. 

 qs s3-object-zone-get|s3-zone-get --ceph-object-zone=value [--flags=value ]
  ceph-object-zone Ceph object zone.
  flags Optional flags for the operation. [force, min]


s3-object-zone-group-get

Returns information about a specific object zone group used to store S3 object data. 

 qs s3-object-zone-group-get|zone-group-get --ceph-object-zone-group=value [--flags=value ]
  ceph-object-zone-group Ceph object zone group.
  flags Optional flags for the operation. [force, min]


s3-object-zone-group-list

Returns a list of all the object zone groups. 

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


s3-object-zone-group-modify

Set configuration values for a specific object zone group used to store S3 object data. 

 qs s3-object-zone-group-modify|zone-group-modify --ceph-object-zone-group=value --hostname-list=value [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  ceph-object-zone-group Ceph object zone group.
  hostname-list A comma delimited list of hostnames, may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-object-zone-list

Returns a list of all the object zone. 

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


s3-tenant-create

Creates a new tenant entry that can then be used to create S3 users under this tenant namespace. 

 qs s3-tenant-create|s3t-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--description=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  display-name Display name for the user.
  ceph-cluster Ceph Cluster name or ID.
  description Description for an enclosure within a hardware controller.
  flags Optional flags for the operation. [min]


s3-tenant-delete

Deletes the specified S3 tenant. 

 qs s3-tenant-delete|s3t-delete --tenant=value [--flags=value ]
  tenant Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
  flags Optional flags for the operation. [min]


s3-tenant-get

Gets information about the specified tenant. 

 qs s3-tenant-get|s3t-get --tenant=value [--flags=value ]
  tenant Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
  flags Optional flags for the operation. [min]


s3-tenant-list

Lists all the S3 tenants in the grid. 

 qs s3-tenant-list|s3t-list [--flags=value ]
  flags Optional flags for the operation. [min]


s3-user-accesskey-add

Adds a new S3 User Access Key to an existing S3 User in a Ceph Cluster. 

 qs s3-user-accesskey-add|s3k-add --s3-user=value [--s3-access-key=value ] [--s3-secret-key=value ] [--flags=value ]
  s3-user Ceph object storage S3 User.
  s3-access-key The access key value of an S3 User Access Key.
  s3-secret-key The secret key value of an S3 User Access Key.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-accesskey-get

Returns information about the specified S3 User Access Key. 

 qs s3-user-accesskey-get|s3k-get --s3-user-access-key=value [--flags=value ]
  s3-user-access-key The name, UUID or access-key value used to identify a S3 User Access Key object.
  flags Optional flags for the operation. [force, min]


s3-user-accesskey-list

Returns a list of all the S3 User Access Keys. 

 qs s3-user-accesskey-list|s3k-list [--ceph-cluster=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [min]


s3-user-accesskey-modify

Modifies the secret key of an existing S3 User Access Key. 

 qs s3-user-accesskey-modify|s3k-modify --s3-user=value --s3-user-access-key=value [--s3-secret-key=value ] [--flags=value ]
  s3-user Ceph object storage S3 User.
  s3-user-access-key The name, UUID or access-key value used to identify a S3 User Access Key object.
  s3-secret-key The new secret key for the existing S3 User Access Key.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-accesskey-remove

Removes the S3 User Access Key from the existing S3 User in a Ceph Cluster. 

 qs s3-user-accesskey-remove|s3k-remove --s3-user=value --s3-user-access-key=value [--flags=value ]
  s3-user Ceph object storage S3 User.
  s3-user-access-key The name, UUID or access-key value used to identify a S3 User Access Key object.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-create

Creates a new S3 User to allow S3 protocol access to the S3 Object Storage Group/Zone. 

 qs s3-user-create|s3u-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--tenant=value ] [--email=value ] [--s3-access-key=value ] [--s3-secret-key=value ] [--access-permission=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--count=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  display-name Display name for the user.
  ceph-cluster Ceph Cluster name or ID.
  tenant Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
  email An email address of the form 'user@example.com' without the quotes.
  s3-access-key The access key value of an S3 User Access Key.
  s3-secret-key The secret key value of an S3 User Access Key.
  access-permission Ceph object storage permission (rwx, rw-, ---) [*all, delete, read, write]
  user Name or ID (GUID) of a existing user.
  max-objects-enable Enable maximum object limits per bucket.
  max-objects Maximum object count per bucket.
  max-size-enable Enable maximum bucket size limits.
  bucket-quota-max-size Maximum amount of data for a given bucket.
  max-user-objects-enable Enable maximum object count limits per user.
  max-user-objects Maximum aggregate number objects that a given user can create.
  max-user-size-enable Enable maximum aggregate capacity/size limits for a given user.
  max-user-size Maximum aggregate capacity limit for a given user or user(s).
  max-buckets Maximum buckets a user can have / create.
  count The number of volumes to create, default is 1.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-delete

Deletes the specified S3 User. 

 qs s3-user-delete|s3u-delete --ceph-cluster=value --s3-user-list=value [--delete-data=value ] [--key-delete=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  s3-user-list Comma delimited list of the Names or IDs of S3 Users.
  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, forget-missing, min, *none]


s3-user-disable

Disable a previously active/enabled S3 User. 

 qs s3-user-disable|s3u-disable --s3-user=value [--flags=value ]
  s3-user Ceph object storage S3 User.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-enable

Enable a previously suspended S3 User. 

 qs s3-user-enable|s3u-enable --s3-user=value [--flags=value ]
  s3-user Ceph object storage S3 User.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3-user-get

Returns information about a specific object storage S3 User. 

 qs s3-user-get|s3u-get --s3-user=value [--flags=value ]
  s3-user Ceph object storage S3 User.
  flags Optional flags for the operation. [force, min]


s3-user-list

Returns a list of all the Ceph Object storage S3 Users and their associated S3 User Access Keys 

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


s3-user-modify

Modifies the name and permissions for a specified S3 User object. 

 qs s3-user-modify|s3u-modify --ceph-cluster=value --s3-user=value [--display-name=value ] [--email=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--flags=value ]
  ceph-cluster Ceph Cluster name or ID.
  s3-user Ceph object storage S3 User.
  display-name Display name for the user.
  email An email address of the form 'user@example.com' without the quotes.
  user Name or ID (GUID) of a existing user.
  max-objects-enable Enable maximum object limits per bucket.
  max-objects Maximum object count per bucket.
  max-size-enable Enable maximum bucket size limits.
  bucket-quota-max-size Maximum amount of data for a given bucket.
  max-user-objects-enable Enable maximum object count limits per user.
  max-user-objects Maximum aggregate number objects that a given user can create.
  max-user-size-enable Enable maximum aggregate capacity/size limits for a given user.
  max-user-size Maximum aggregate capacity limit for a given user or user(s).
  max-buckets Maximum buckets a user can have / create.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]

S3 Reverse Proxy Management [S3PROXY]

Commands for managing S3 reverse proxies.

s3proxy-create

Creates a new S3 Reverse Proxy configuration on the specified system. 

 qs s3proxy-create|s3p-create --name=value --proxy-server-fqdn=value --proxy-endpoint-fqdn=value [--storage-system=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  proxy-server-fqdn Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
  proxy-endpoint-fqdn Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
  storage-system Name or ID of a Storage System in a management grid.
  sslcert-file Path to a file which contains the SSL Certificate to the read and passed to the server.
  sslkey-file Path to a file which contains the SSL Certificate Key to be read and passed to the server.
  port-numbers List of port numbers to be associated with the proxy.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3proxy-delete

Deletes the specified S3 Reverse Proxy configuration. 

 qs s3proxy-delete|s3p-delete --s3proxy=value [--flags=value ]
  s3proxy Name or ID of an S3 Reverse Proxy configuration.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


s3proxy-get

Returns information about a specific S3 Reverse Proxy configuration. 

 qs s3proxy-get|s3p-get --s3proxy=value [--flags=value ]
  s3proxy Name or ID of an S3 Reverse Proxy configuration.
  flags Optional flags for the operation. [force, min]


s3proxy-list

Returns a list of all the configured S3 Reverse Proxies in the system/grid. 

 qs s3proxy-list|s3p-list [--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]


s3proxy-modify

Modifies the settings/properties of an S3 Reverse Proxy configuration. 

 qs s3proxy-modify|s3p-modify --s3proxy=value [--name=value ] [--proxy-server-fqdn=value ] [--proxy-endpoint-fqdn=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ]
  s3proxy Name or ID of an S3 Reverse Proxy configuration.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  proxy-server-fqdn Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
  proxy-endpoint-fqdn Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider S3 region endpoint.
  sslcert-file Path to a file which contains the SSL Certificate to the read and passed to the server.
  sslkey-file Path to a file which contains the SSL Certificate Key to be read and passed to the server.
  port-numbers List of port numbers to be associated with the proxy.
  desc A description for the object.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]

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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the command. [min]


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 ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  resource-group Name of a Resource Group 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.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  rc-hourly Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-weeklies Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-monthlies Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-quarterlies Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  flags Optional flags for the operation. [async]
  include-nested-shares Include nested shares.


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 [--flags=value ]
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the command. [force, min]


snap-schedule-list

Returns a list of all the snapshot schedules. 

 qs snap-schedule-list|sch-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ]
  schedule Name of a snapshot schedule or its unique ID (GUID).
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  resource-group Name of a Resource Group 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.
  schedule-type Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
  interval (interval based) Delay interval in minutes between when a schedule run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
  days (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
  hours (calendar based) 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]
  offset-minutes (calendar based) 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.
  rc-hourly Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
  rc-weeklies Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
  rc-monthlies Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
  rc-quarterlies Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
  flags Optional flags for the operation. [async]
  include-nested-shares Include nested shares.


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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


snap-schedule-trigger

Triggers the specified schedule to run immediately. 

 qs snap-schedule-trigger|sch-trigger --schedule=value [--flags=value ]
  schedule Name of a snapshot schedule or its unique ID (GUID).
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

iSCSI/FC/NFS/SMB Session Management [SESSION]

Commands for iSCSI/FC/NFS/SMB storage session management.

share-session-get

Returns information about a specific NFS/SMB session. 

 qs share-session-get|share-sn-get --share-session=value [--flags=value ]
  share-session A Network Share session represents a NAS client connection/session via the SMB and/or NFS protocol.
  flags Optional flags for the command. [min]


share-session-list

Returns a list of all the open SMB sessions. 

 qs share-session-list|share-sn-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


volume-session-close

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

 qs volume-session-close|volume-sn-close [--volume=value ] [--session-list=value ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  session-list iSCSI session identifier for an active iSCSI session.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


volume-session-get

Returns detailed information on a specific iSCSI session. 

 qs volume-session-get|volume-sn-get --session=value [--flags=value ]
  session iSCSI session identifier for an active iSCSI session.
  flags Optional flags for the command. [force, min]


volume-session-list

Returns a list of all the active iSCSI sessions. 

 qs volume-session-list|volume-sn-list [--volume=value ] [--host=value ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  host Name of the host or its unique ID (GUID).
  flags Optional flags for the command. [min]

Network Share Management [SHARE]

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

active-dir-domain-list

Returns a list of all domains including the trusted domains. 

 qs active-dir-domain-list|ad-dom-list --storage-system=value [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force]


active-dir-user-group-list

Returns a list of all the users and groups in the Active Directory domain that the appliance is a member of. Search result is limited to 1000 users/groups. Consider narrowing down the search for a list of all users/groups 

 qs active-dir-user-group-list|ad-ug-list --storage-system=value [--is-group=value ] [--domain=value ] [--organization-unit=value ] [--filter=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  is-group List active directory users or groups. Default is users
  domain Search users or groups in the specified domain. If not specified the default domain will be used.
  organization-unit Search users or groups in the specified organization unit. If not specified, the base domain will be used to search.
  filter Filter to search users or groups. Example user*dom*. If not specified, all users or groups will be search.
  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]


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 [--retain-client-connection=value ] [--flags=value ]
  share Name or ID of a Network Share.
  filter A filter string for the client
  retain-client-connection Retain client connection. Default is false.
  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 ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--reserved=value ] [--vvol-type=value ] [--protocol-end-point=value ] [--is-cloud-container-cache=value ] [--nfs-security-policy=value ] [--parent-share=value ] [--encrypt=value ] [--encryption-key=value ] [--count=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--immutability-mode=value ] [--days-of-immutability=value ] [--small-block-threshold=value ] [--file-quota=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
  cifs-options CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties. If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
  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]
  primarycache Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
  secondarycache Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
  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).
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
  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--
  recordsize Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  vvol-type vvol type for VASA support. Type can be none for no VASA support, protocolEndPoint or subVol. Default is none. [*none, protocol-end-point, subvol-config, subvol-data, subvol-swap]
  protocol-end-point Protocol Endpoint ID only applies to VVOL based Network Shares and indicates the parent share on which the VVOL should be created.
  is-cloud-container-cache Indicates if this share is to be used as Cloud Container cache. 'true' if used as a cache.
  nfs-security-policy By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
  parent-share The ID or name of the Network Share to link a given alias or sub-share to.
  encrypt Enables encryption for the specified share. Network Share level encryption is independent from the encryption setting for the Storage Pool which may be encrypted or unencrypted. Encryption can only be enabled at the time of storage resource creation.
  encryption-key A passphrase which is used to encrypt all the data sent to the storage resource.
  count The number of volumes to create, default is 1.
  disable-vss-snap-browsing Disable VSS snapshot browsing.
  disable-smb-snap-dir Disables SMB _snaps folder browsing of activated GMT snapshots.
  disable-nfs-snap-dir Enables NFS _snaps folder browsing of activated GMT snapshots.
  disable-nfs-hidden-dir-browsing Disables NFS snapshot browsing for .zfs folder
  immutability-mode Enables file immutability/WORM support for the specified share on creation. [append, immutable, *none]
  days-of-immutability The number of days a new file will be marked as immutable. After the file is old enough, it will be marked mutable at midnight.
  small-block-threshold Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
  file-quota Quota on the number of files within the Network Share.
  flags Optional flags for the operation. [async, force]


share-create-alias

Creates an alias for the specified share. Aliases have their own separate permissions settings which can be customized and can inherit from it's associated parent share. Aliases can also reference a sub-directory of the parent share. 

 qs share-create-alias|shr-create-alias --name=value --parent-share=value [--subpath=value ] [--inherit-access=value ] [--desc=value ] [--public=value ] [--active=value ] [--force-create-sub-dir=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  parent-share The ID or name of the Network Share to link a given alias or sub-share to.
  subpath Sub-directory within the parent share to associate with this sub-share. If the directory doesn't exist it will be created automatically and the sub-path can refer to a directory which is nested multiple levels deep.
  inherit-access Inherit access control settings from the parent share including the NFS access entries and CIFS user/group access entries. [cifs, nfs, *none]
  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.
  force-create-sub-dir Force creation of sub directory if not present. Without this option existing directory will not be used if present.
  flags Optional flags for the operation. [async, force]


share-delete

Deletes the specified Network Share 

 qs share-delete|shr-delete [--share-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ]
  share-list A list of one or more Network Shares.
  delete-child-snaps-only Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
  delete-child-snaps-and-parent Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
  search-filter Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  dry-run-only Dry run will not delete any shares, only returns a list of shares found by the specified search criteria and options
  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-file-lock-list

Returns a list of all the open files (SMB only) for the specified Network Share. 

 qs share-file-lock-list|shr-lock-list [--share=value ] [--storage-system=value ] [--flags=value ]
  share Name or ID of a Network Share.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [force]


share-get

Returns information about the specified Network Share. 

 qs share-get|shr-get --share=value [--flags=value ]
  share Name or ID of a Network Share.
  flags Optional flags for the command. [force, min]


share-group-quota-add

Set a group quota for the Network Share 

 qs share-group-quota-add|shr-group-quota-add --share=value --user-group=value --quota-size=value [--flags=value ]
  share Name or ID of a Network Share.
  user-group A group of one or more users.
  quota-size Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  flags Optional flags for the operation. [async, force]


share-group-quota-remove

Remove a group quota for the Network Share 

 qs share-group-quota-remove|shr-group-quota-remove --share=value --user-group=value [--flags=value ]
  share Name or ID of a Network Share.
  user-group A group of one or more users.
  flags Optional flags for the operation. [async, force]


share-health-check

Checks the health/state of the share and recursively checks the health of the associated pool and it's disk devices to see if there are any health issues anywhere in the stack. 

 qs share-health-check|shr-check --share=value [--flags=value ]
  share Name or ID of a Network Share.
  flags Optional flags for the operation. [min]


share-hold-add

Add a hold on a Network Share snapshot to prevent it from getting deleted. Releasing the hold will allow deletion. 

 qs share-hold-add|shr-hld-add --share=value [--hold-tag=value ] [--flags=value ]
  share Name or ID of a Network Share.
  hold-tag Tag identifying the hold.
  flags Optional flags for the operation. [min]


share-hold-remove

Remove a hold on a Network Share snapshot. Releasing the hold will allow deletion. 

 qs share-hold-remove|shr-hld-remove --share=value [--hold-tag=value ] [--flags=value ]
  share Name or ID of a Network Share.
  hold-tag Tag identifying the hold.
  flags Optional flags for the operation. [min]


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 ] [--allow-trusted-domains=value ] [--computer-act-ou=value ] [--min-uid=value ] [--max-uid=value ] [--min-def-uid=value ] [--max-def-uid=value ] [--range-size=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  domain The name of the AD domain to have the Storage System join. (DOMAIN)
  realm The name of the AD realm that the domain is in. (DOMAIN.COM)
  kdc The name of the Active Directory server/machine.
  ad-admin The AD administrator account of the domain that Storage System is a member of or joining.
  ad-password The AD password to the administrator account of the domain that Storage System is a member of or joining.
  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]
  allow-trusted-domains Allow discovery of trusted domains (default=false)
  computer-act-ou Organization Unit to create the computer account in
  min-uid Min UID in the range
  max-uid Max UID in the range
  min-def-uid Max UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
  max-def-uid Min UID for the default tdb backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
  range-size Defines the number of uids/gids available per domain range. Only used in idmap mode 'autorid'
  flags Optional flags for the operation. [async, force]


share-key-export

Exports all the encryption key information for the specified Network Share into a block that can be used in the future to re-import the keys. 

 qs share-key-export|shr-key-export --network-share=value --key-file=value [--flags=value ]
  network-share Name or ID of a CIFS/NFS Network Share.
  key-file File name to use for the exported pool key block.
  flags Optional flags for the operation. [min]


share-key-import

Import the previously exported encryption keys for a Network Share to the specified Storage System. 

 qs share-key-import|shr-key-import --key-file=value --network-share=value [--flags=value ]
  key-file File which contains the previously exported key block to use for importing.
  network-share Name or ID of a CIFS/NFS Network Share.
  flags Optional flags for the operation. [min]


share-leave-domain

Leaves the current Active Directory domain. 

 qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--preserve-access-entries=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  ad-admin The AD administrator account of the domain that Storage System is a member of or joining.
  ad-password The AD password to the administrator account of the domain that Storage System is a member of or joining.
  preserve-access-entries When a system is removed from an AD domain all local storage pools will have their AD user access control information scrubbed from all Network Shares unless preserve entries is specified. (default=true)
  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 [--vasa-support-only=value ] [--include-snapshots=value ] [--flags=value ]
  vasa-support-only VASA support only.
  include-snapshots Include snapshots in the list
  flags Optional flags for the command. [min]


share-load-encryption-key

Load the encryption key of an encrypted network share so that the key is in the available state. 

 qs share-load-encryption-key|shr-load-key --network-share=value [--encryption-key=value ] [--flags=value ]
  network-share Name or ID of a CIFS/NFS Network Share.
  encryption-key A passphrase which is used to encrypt all the data sent to the storage resource.
  flags Optional flags for the operation. [async, force]


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 ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--cifs-enable=value ] [--user-access-list=value ] [--group-access-list=value ] [--cifs-options=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--is-active-checkpoint=value ] [--reserved=value ] [--nfs-security-policy=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--small-block-threshold=value ] [--file-quota=value ] [--flags=value ]
  share Name or ID of a Network Share.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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]
  primarycache Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
  secondarycache Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
  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:admin,@ugroup:valid,~DOMAIN+user7,~user33', prepend with tilde (~) to remove fields/properties. Prepend with '@' to specify a user group.
  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. If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
  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--
  recordsize Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
  is-active-checkpoint Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system. Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage session.
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  nfs-security-policy By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
  disable-vss-snap-browsing Disable VSS snapshot browsing.
  disable-smb-snap-dir Disables SMB _snaps folder browsing of activated GMT snapshots.
  disable-nfs-snap-dir Enables NFS _snaps folder browsing of activated GMT snapshots.
  disable-nfs-hidden-dir-browsing Disables NFS snapshot browsing for .zfs folder
  small-block-threshold Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
  file-quota Quota on the number of files within the Network Share.
  flags Optional flags for the operation. [async]


share-move

Moves the specified Network Share inside an existing Network Share. 

 qs share-move|sh-move --share=value --new-parent=value [--new-name=value ] [--flags=value ]
  share Name or ID of a Network Share.
  new-parent New parent for the specified nested share
  new-name New name for the share. If left name, existing name will be used for the move
  flags Optional flags for the operation. [async, force]


share-quota-list

Returns the user quotas for the Network Share. 

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


share-restore

Restores the specified Network Share with the contents of the specified snapshot. 

 qs share-restore|shr-restore --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-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-search

Returns a subset of Network Shares matching the given criteria. 

 qs share-search|shr-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [force, min]


share-set-passphrase

Sets or changes the encryption passphrase for an encrypted network share. 

 qs share-set-passphrase|shr-set-passphrase --network-share=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ]
  network-share Name or ID of a CIFS/NFS Network Share.
  current-passphrase Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
  new-passphrase New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
  flags Optional flags for the operation. [async]


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 ] [--lazy-clone=value ] [--flags=value ]
  share Name or ID of a Network Share.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  active Indicates that the Network Share should be activated.
  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.
  flags Optional flags for the operation. [async, force]


share-unload-encryption-key

Unload the encryption key of an encrypted network share so that the key is in the unavailable state. 

 qs share-unload-encryption-key|shr-unload-key --network-share=value [--flags=value ]
  network-share Name or ID of a CIFS/NFS Network Share.
  flags Optional flags for the operation. [async, force]


share-user-quota-add

Set a user quota for the Network Share 

 qs share-user-quota-add|shr-user-quota-add --share=value --user=value --quota-size=value [--flags=value ]
  share Name or ID of a Network Share.
  user Name or ID (GUID) of a existing user.
  quota-size Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  flags Optional flags for the operation. [async, force]


share-user-quota-remove

Remove a user quota for the Network Share. 

 qs share-user-quota-remove|shr-user-quota-remove --share=value --user=value [--flags=value ]
  share Name or ID of a Network Share.
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the operation. [async, force]

Site Cluster Resource Management [SITE]

Site Clusters manage virtual interfaces to which can float between cluster members to ensure high-availability to Storage Pools and other resources. 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 ] [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


cluster-ring-delete

Deletes the specified cluster ring configuration. 

 qs cluster-ring-delete|cr-delete --cluster-ring=value [--flags=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
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=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
  flags Optional flags for the command. [force, min]


cluster-ring-list

Returns a list of the cluster ring configurations. 

 qs cluster-ring-list|cr-list [--flags=value ]
  flags Optional flags for the command. [min]


cluster-ring-member-get

Returns information about the specified cluster ring member. 

 qs cluster-ring-member-get|crm-get --cluster-ring-member=value [--flags=value ]
  cluster-ring-member A cluster-ring-member represents a physical interface on a appliance used for cluster communication.
  flags Optional flags for the command. [force, min]


cluster-ring-member-list

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

 qs cluster-ring-member-list|crm-list [--flags=value ]
  flags Optional flags for the command. [min]


site-cluster-add-nodes

Add the specified Storage Systems to the site cluster. 

 qs site-cluster-add-nodes|sc-add-nodes --site=value --system-list=value [--flags=value ]
  site A site is a group of appliances in a location.
  system-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async]


site-cluster-assoc-get

Returns detailed information about the specified site association. 

 qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] [--flags=value ]
  system The system with the site association.
  site-assoc A site association is a link between a system and a site.
  flags Optional flags for the command. [force, min]


site-cluster-assoc-list

Returns a list of all the configured site association. 

 qs site-cluster-assoc-list|sca-list [--flags=value ]
  flags Optional flags for the command. [min]


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 --system-ip-list=value [--desc=value ] [--location=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  system-ip-list List of the IP addresses, one from each system to be selected to form a new Site Cluster. The selected IPs will be used to form the initial heart-beat ring and must be from the same network.
  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 [--flags=value ]
  site A site is a group of appliances in a location.
  flags Optional flags for the command. [force, min]


site-cluster-list

Returns a list of all the configured sites. 

 qs site-cluster-list|sc-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=value ]
  site A site is a group of appliances in a location.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  location Optional description indicating the location of the Storage System.
  flags Optional flags for the command. [async]


site-cluster-remove-nodes

Remove the specified Storage Systems from the site cluster. 

 qs site-cluster-remove-nodes|sc-remove-nodes --site=value --system-list=value [--flags=value ]
  site A site is a group of appliances in a location.
  system-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async]


site-cluster-rescan

Rescans the Site Cluster configuration for a given Site Cluster. 

 qs site-cluster-rescan|sc-rescan [--site=value ] [--flags=value ]
  site A site is a group of appliances in a location.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


site-cluster-restart-services

Restarts the corosync/pacemaker services on the specified appliance. 

 qs site-cluster-restart-services|sc-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]


site-cluster-toggle-maintenance-mode

Toggles maintenance mode for the given Site Cluster. Warning: when Site Cluster is in maintenance mode, all Site Cluster Vifs will become unmanaged. 

 qs site-cluster-toggle-maintenance-mode|sc-tog-mmode --site=value --enable-maintenance-mode=value [--flags=value ]
  site A site is a group of appliances in a location.
  enable-maintenance-mode If true, puts the Site Cluster into maintenance mode. If false, brings Site Cluster our of maintenance mode.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


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 ] [--mac-address=value ] [--description=value ] [--location-config=value ] [--usecase-obj-id=value ] [--vif-use-case=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--mtu=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=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)
  mac-address MAC Address
  description Description for an enclosure within a hardware controller.
  location-config List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
  usecase-obj-id Name or ID of the usecase object associated with this vif (ie, HA Group for a HA Vif, Ceph Cluster for a File pool Vif, etc)
  vif-use-case Specifies the use case in which the new vif shall be used. [grid-primary, *ha, other, s3proxy, scaleout-block, scaleout-file, scaleout-obj]
  iscsi-enable Enables or disables iSCSI access to the specified port(s).
  nvmeof-enable Enables or disables NVMEoF TCP access to the specified port(s).
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  fqdn When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
  convert-vif Convert existing local virtual ip address into an HA site VIF.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--convert-to-vif=value ] [--flags=value ]
  vif-resource A site virtual interface resource.
  convert-to-vif Convert HA site VIF resource into a local virtual ip address.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  vif-resource A site virtual interface resource.
  flags Optional flags for the command. [force, min]


site-vif-list

Returns a list of all the virtual interface site resources. 

 qs site-vif-list|svr-list [--flags=value ]
  flags Optional flags for the command. [min]


site-vif-location-constraint-get

Returns a specific location constraint for a Site Vif Resource given the Site Vif Resource and the associated Storage System Node. 

 qs site-vif-location-constraint-get|sv-lc-get --vif-resource=value --storage-system=value [--flags=value ]
  vif-resource A site virtual interface resource.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


site-vif-location-constraint-list

Returns a list of all the location constraints for all Site Vif Resources. 

 qs site-vif-location-constraint-list|sv-lc-list [--vif-resource=value ] [--flags=value ]
  vif-resource A site virtual interface resource.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


site-vif-modify

Updates a given Site Vif's use case, use case object, and/or location constraints. 

 qs site-vif-modify|svr-modify --vif-resource=value [--description=value ] [--location-config=value ] [--flags=value ]
  vif-resource A site virtual interface resource.
  description Description for an enclosure within a hardware controller.
  location-config List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


site-vif-move

Moves the virtual interface resource from the current system it is attached to the specified Storage System. The target Storage System must be a member of the site cluster configuration. 

 qs site-vif-move|svr-move --vif-resource=value --move-to-system=value [--flags=value ]
  vif-resource A site virtual interface resource.
  move-to-system Destination system to move the virtual interface over to.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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, SCSI, 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 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 Tier. 

 qs storage-tier-get|st-get --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 command. [force, min]


storage-tier-list

Returns a list of all the Storage Tiers. 

 qs storage-tier-list|st-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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, SCSI, 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 command. [async]


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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=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.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Software Controller / iSCSI SAN Adapter [SWC]

Storage Systems may connect to other SANs via iSCSI via the additon of one or more iSCSI Software Adapters/Controllers.

sw-controller-add

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

 qs sw-controller-add|swc-add --storage-system=value --name=value --ip-address=value --sw-controller-type=value [--desc=value ] [--port=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  port Port number for the Software Controller portal, defaults to 3260 if iSCSI, or 4420 if NVMe.
  sw-controller-type Protocol type of Software Controller. [*iscsi, nvme-rdma, nvme-tcp]
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 --system-list=value --volume-list=value [--flags=value ]
  system-list List of one or more Storage Systems.
  volume-list List of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


sw-controller-get

Gets detailed information about a specific software SAN controller. 

 qs sw-controller-get|swc-get --sw-controller=value [--flags=value ]
  sw-controller Specifies the name or ID of a software SAN controller instance.
  flags Optional flags for the command. [force, min]


sw-controller-list

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

 qs sw-controller-list|swc-list [--flags=value ]
  flags Optional flags for the command. [min]


sw-controller-remove

Removes the specified iSCSI or NVMe SAN adapter 

 qs sw-controller-remove|swc-remove --sw-controller=value [--flags=value ]
  sw-controller Specifies the name or ID of a software SAN controller instance.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


sw-controller-scan

Scans the specified iSCSI/NVMe SAN adapter for iSCSI/NVMe targets. 

 qs sw-controller-scan|swc-scan --sw-controller=value [--flags=value ]
  sw-controller Specifies the name or ID of a software SAN controller instance.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


sw-controller-target

Returns the specified software controller target. 

 qs sw-controller-target|swc-target --target=value [--flags=value ]
  target The software controller target to operate against
  flags Optional flags for the command. [force, min]


sw-controller-target-list

Returns a list of all the discovered software controller targets. 

 qs sw-controller-target-list|swc-target-list [--sw-controller=value ] [--flags=value ]
  sw-controller Specifies the name or ID of a software SAN controller instance.
  flags Optional flags for the command. [min]


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 [--flags=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
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=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
  flags Optional flags for the command. [async, force]


sw-disk-session

Returns the specified software disk session. 

 qs sw-disk-session|swc-session --session=value [--flags=value ]
  session The software disk session to operate against
  flags Optional flags for the command. [force, min]


sw-disk-session-list

Returns a list of all software disk sessions. 

 qs sw-disk-session-list|swc-session-list [--sw-controller=value ] [--flags=value ]
  sw-controller Specifies the name or ID of a software SAN controller instance.
  flags Optional flags for the command. [min]

Storage System Management [SYSTEM]

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

enter-system-maintenance

Set the Storage System(s) in Maintenance mode. 

 qs enter-system-maintenance|en-maint --system-list=value [--enter=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  enter Flags to be passed to set one or more subsystem in the Storage System(s) in Maintenance Mode. [*all, ceph, corosync]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


exit-system-maintenance

Get the Storage System(s) out of Maintenance mode. 

 qs exit-system-maintenance|ex-maint --system-list=value [--exit=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  exit Flags to be passed to move one or more subsystem in the Storage System(s) out of Maintenance Mode. [*all, ceph, corosync]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


system-beacon

Activates system LED beacon and produces an audible beep pattern for the specified duration to help physically identify a given Storage System within the environment. 

 qs system-beacon|sys-beep [--duration-sec=value ] [--storage-system=value ] [--flags=value ]
  duration-sec Total time duration in seconds to sustain the system audible beep pattern.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


system-get

Get general information about the Storage System. 

 qs system-get|sys-get [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [force, min]


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 [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


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 ] [--enclosure-layout=value ] [--domain-suffix=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--multipath-autoconfig=value ] [--hw-auto-maintenance=value ] [--log-collection=value ] [--eth-naming=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--disable-io-fencing=value ] [--wwn-emulation=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.
  enclosure-layout Enclosure layout for an enclosure within a hardware controller.
  domain-suffix 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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *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.
  multipath-autoconfig When enabled multipathing is automatically configured for devices that support it. [disabled, enabled]
  hw-auto-maintenance Flags to be passed to set one or more automatic repair modes in the Storage System's storage resources. [*none, osd, pool]
  log-collection When enabled logs are sent periodically for automatic analysis. [biweekly, monthly, never, weekly]
  eth-naming Applies either Predictable (Predictable Network Interface Naming/PNIN) port naming convention (ensN, enoN, enpN) or Unified (ethN) port naming convention. Unified (ethN) based naming is the preferred mode as it applies a consistent naming across systems which is needed for highly available cluster VIF management. [*nochange, predictable, unified]
  protocol-block The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
  protocol-block-reset Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
  disable-io-fencing Disables all I/O fencing operations on the system for all media devices. This should only be used on systems used in scale-out configurations and not scale-up HA pool configurations which require the I/O fencing system.
  wwn-emulation Enables FC WWN emulation and device naming mode to emulate 3rd party SANs. [ibm_storwize, *none, osnexus_ieee, pure_flasharray]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


system-ping

Returns the name, ID, and version of the system without authentication to support discovery services. 

 qs system-ping|sys-ping [--flags=value ]
  flags Optional flags for the command. [min]


system-platform-event

Signal the service with an event. 

 qs system-platform-event|sys-pe --event-type=value --event-message=value [--flags=value ]
  event-type The class of event that is being signaled.
  event-message The message/key of the event to signal.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


system-restart

Restarts the entire Storage System. 

 qs system-restart|restart --system-list=value [--yes-i-really-mean-it=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  yes-i-really-mean-it Confirms that user is sure they want to execute operation
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


system-shutdown

Shutdown the Storage System. 

 qs system-shutdown|shutdown --system-list=value [--service-only=value ] [--yes-i-really-mean-it=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  service-only Shutdown just the management service and not the system.
  yes-i-really-mean-it Confirms that user is sure they want to execute operation
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


system-signal-manager

Send signal to named manager module. 

 qs system-signal-manager|sys-sigmgr --manager-class=value [--storage-system=value ] [--flags=value ]
  manager-class The code/identifier of the manager to receive the signal. [alua, blink, ceph, disk, fabric, firewall, gridsync, ha, haconn, hardware, hotspare, infiniband, pool, replication, sed, sharenamespace, smart, stats, targetport]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


system-upgrade

Upgrade to the latest version of the core packages. 

 qs system-upgrade|upgrade [--system-list=value ] [--include-kernel=value ] [--distro-upgrade=value ] [--allow-reboot=value ] [--core-only=value ] [--ceph-upgrade=value ] [--ceph-cluster=value ] [--flags=value ]
  system-list List of one or more Storage Systems.
  include-kernel Include kernel and driver updates (default=false)
  distro-upgrade Perform a distribution upgrade (default=false)
  allow-reboot Allow reboots to occur automatically when one is required.
  core-only Only upgrade the core Service and WUI/Manager packages.
  ceph-upgrade Set this option to upgrade Ceph daemons for the given cluster members.
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the operation. [async, force, forget-missing, 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 ] [--flags=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.
  flags Optional flags for the command. [min]


timezone-set

Sets the time zone for the specified storage appliance. 

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


tunable-get

Returns the value of a specific tunable for the specified system. 

 qs tunable-get|sst-get --tunable=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  tunable A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
  flags Optional flags for the command. [force, min]


tunable-list

Returns a list of all the system performance tuning which can be used to adjust cache and other settings for specific use cases. 

 qs tunable-list|sst-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


tunable-profile-apply

Applies the specified Storage System tuning profile. 

 qs tunable-profile-apply|sstp-apply --tunable-profile=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  tunable-profile Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
  flags Optional flags for the command. [min]


tunable-profile-create

Creates a new Storage System tuning profile with the specified list of tunings. 

 qs tunable-profile-create|sstp-create --name=value --desc=value --tunable=value [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  tunable A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
  flags Optional flags for the command. [min]


tunable-profile-delete

Deletes the specified Storage System tuning profile. 

 qs tunable-profile-delete|sstp-delete --tunable-profile=value [--flags=value ]
  tunable-profile Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
  flags Optional flags for the command. [min]


tunable-profile-get

Returns information about the specified profile. 

 qs tunable-profile-get|sstp-get --tunable-profile=value [--flags=value ]
  tunable-profile Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
  flags Optional flags for the command. [force, min]


tunable-profile-list

Returns a list of all the Storage System tuning profiles. 

 qs tunable-profile-list|sstp-list [--flags=value ]
  flags Optional flags for the command. [min]


tunable-profile-modify

Modifies the specified Storage System tuning profile. 

 qs tunable-profile-modify|sstp-modify --tunable-profile=value [--name=value ] [--desc=value ] [--tunable=value ] [--flags=value ]
  tunable-profile Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  tunable A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
  flags Optional flags for the command. [min]


tunable-set

Sets the value of a specific tunable for the specified system. 

 qs tunable-set|sst-set --tunable=value [--storage-system=value ] [--tunable-option=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  tunable-option Options for setting or resetting all tunables for a given need like IOPS, resilvering, and system defaults. [*none, reset]
  tunable A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list provide a comma delimited list in the format key:value,key:value,...
  flags Optional flags for the command. [min]

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.

replication-link-create

Create a new Storage System Replication Link so that Storage Volumes may be replicated between Storage Systems. 

 qs replication-link-create|rl-create --storage-system=value --remote-system=value --local-ip=value --remote-ip=value [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=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 megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
  compression Links always transmit data on-the-wire using fast compression (zip based)
  encryption Links always transmit data on-the-wire with AES-256 bit encryption by default
  desc A description for the object.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


replication-link-delete

Delete an existing replication link. 

 qs replication-link-delete|rl-delete --link=value [--flags=value ]
  link Storage system link ID or name.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


replication-link-get

Get information about the replication link. 

 qs replication-link-get|rl-get --link=value [--flags=value ]
  link Storage system link ID or name.
  flags Optional flags for the command. [force, min]


replication-link-list

List the existing replication links. 

 qs replication-link-list|rl-list [--flags=value ]
  flags Optional flags for the command. [min]


replication-link-modify

Modify the properties of the replication link. 

 qs replication-link-modify|rl-modify --link=value --remote-ip=value [--local-ip=value ] [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ]
  link Storage system link ID or name.
  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 megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
  compression Links always transmit data on-the-wire using fast compression (zip based)
  encryption Links always transmit data on-the-wire with AES-256 bit encryption by default
  desc A description for the object.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Tag/Object Property Management [TAG]

Feature which allows any object within the Storage System/Grid 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-delete

Deletes a specific tag on a specific object. 

 qs tag-delete|prop-delete --object-id=value --tag=value [--flags=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.
  flags Optional flags for the command. [min]


tag-get

Returns information on a specific tag on a specific object. 

 qs tag-get|prop-get --object-id=value --tag=value [--flags=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.
  flags Optional flags for the command. [min]


tag-list

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

 qs tag-list|prop-list --object-id=value [--flags=value ]
  object-id UUID of the object to associate the tag with.
  flags Optional flags for the command. [min]


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 ] [--flags=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 [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


bonded-interface-delete

Deletes the specified bonded network interface. 

 qs bonded-interface-delete|bond-delete --port=value [--storage-system=value ] [--flags=value ]
  port Name or unique ID of a network port/target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


client-connection-list

Lists all active client connections to the specified system. 

 qs client-connection-list|ccon-list [--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]


fiber-channel-port-disable

Disables the specified fiber channel port. 

 qs fiber-channel-port-disable|fcp-disable --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


fiber-channel-port-enable

Enables the specified fiber channel port. 

 qs fiber-channel-port-enable|fcp-enable --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, 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. [force, min]


fiber-channel-port-issuelip

Sends a FC LIP command the specified fiber channel port to force a rediscovery of LUNs / Storage Volumes. 

 qs fiber-channel-port-issuelip|fcp-issuelip --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


fiber-channel-port-list

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

 qs fiber-channel-port-list|fcp-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


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. [force, min]


infiniband-port-list

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

 qs infiniband-port-list|ibp-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


network-port-disable

Disables the specified target port. 

 qs network-port-disable|np-disable --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


network-port-enable

Enables the specified target port. 

 qs network-port-enable|np-enable --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


network-port-get

Returns information about the specified target port. 

 qs network-port-get|np-get --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [force, min]


network-port-list

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

 qs network-port-list|np-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


network-port-modify

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

 qs network-port-modify|np-modify --port=value [--port-type=value ] [--storage-system=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--lossless-networking-enabled=value ] [--auto-tune=value ] [--desc=value ] [--bond-mode=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--protocol-allow=value ] [--protocol-allow-reset=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)
  storage-system Name or ID of a Storage System in a management grid.
  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).
  nvmeof-enable Enables or disables NVMEoF TCP access to the specified port(s).
  lossless-networking-enabled Enables or disables lossless networking for Melanox ports.
  auto-tune Enables automatic configuration of the RX/TX buffers to maximize throughput for large block I/O and replication.
  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. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer34, *round-robin]
  protocol-block The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
  protocol-block-reset Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
  protocol-allow The protocol that needs to be allowed specified as 'nfs,smb'. prepend with tilde (~) to remove from the allow list. Protocols already allowed will be retained. To reset the allow list, use 'protocol-allow-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
  protocol-allow-reset Reset the protocol allow list. Any values provided in the argument protocol-allow will be ignored.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


network-port-rename

Creates a systemd link file to rename target port. 

 qs network-port-rename|np-rename --port=value --name=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  name New name to assign to target port. It is suggested to have a static network management port with naming prefix 'mgmt'. Avoid using naming prefix 'eth' as it may cause naming conflicts with kernel drivers. Network interfaces are typically enumerated from a 0 index e.g. eno[0,1,2,...]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


network-port-rescan

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

 qs network-port-rescan|np-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, forget-missing, min, *none]


network-port-restart

Restarts the specified target port. 

 qs network-port-restart|np-restart --port=value [--storage-system=value ] [--flags=value ]
  port Name or MAC address of the target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


provider-app-get

Get the registered provider information. 

 qs provider-app-get|prov-app-get --provider-type=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  provider-type Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
  flags Optional flags for the operation. [force]


provider-app-list

List the registered providers. 

 qs provider-app-list|prov-app-list [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


provider-app-register

Register a provider. 

 qs provider-app-register|prov-app-register --provider-type=value [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  provider-type Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


provider-app-unregister

Unregister a provider. 

 qs provider-app-unregister|prov-app-unregister [--provider-app=value ] [--flags=value ]
  provider-app Provider to unregister.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


service-firewall-definition-list

List the firewall definitions for the services 

 qs service-firewall-definition-list|src-firewall-df-list [--flags=value ]
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


static-route-create

Creates a new network static route for connecting to other networks. 

 qs static-route-create|sr-create --port=value --destination-ip-address=value --destination-netmask=value --gateway-ip-address=value [--storage-system=value ] [--flags=value ]
  port Name or unique ID of a network port/target port.
  destination-ip-address Destination IP address for the static route.
  destination-netmask Destination subnet mask for the static route.
  gateway-ip-address Gateway IP address for the static route
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [min]


static-route-delete

Deletes the specified static route identified by its UUID. 

 qs static-route-delete|sr-delete --route-id=value [--flags=value ]
  route-id UUID of a static route object.
  flags Optional flags for the operation. [min]


static-route-get

Returns information on a specific static route. 

 qs static-route-get|sr-get --route-id=value [--flags=value ]
  route-id UUID of a static route object.
  flags Optional flags for the operation. [min]


static-route-list

Returns a list of all the static routes. 

 qs static-route-list|sr-list [--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]


storage-system-capabilities-list

List the Storage System capabilities. 

 qs storage-system-capabilities-list|sys-capabilities-list [--flags=value ]
  flags Optional flags for the command. [async, force, forget-missing, 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 ] [--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
  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, forget-missing, min, *none]


virtual-interface-delete

Deletes the specified virtual network interface. 

 qs virtual-interface-delete|vif-delete --port=value [--storage-system=value ] [--flags=value ]
  port Name or unique ID of a network port/target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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, forget-missing, min, *none]


vlan-interface-delete

Deletes the specified VLAN interface. 

 qs vlan-interface-delete|vlan-delete --port=value [--storage-system=value ] [--flags=value ]
  port Name or unique ID of a network port/target port.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 [--flags=value ]
  task ID of a task.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


task-get

Returns information about the specified task. 

 qs task-get|t-get --task=value [--flags=value ]
  task ID of a task.
  flags Optional flags for the command. [force, min]


task-list

Returns a list of all the Tasks including active, completed, and failed tasks. Whenever you run a command in the Storage Grid it is queued in the internal Task Manager and then executed automatically once the necessary resource locks are acquired. 

 qs task-list|t-list [--filtered=value ] [--flags=value ]
  filtered Returns just the 'value' most recently created.
  flags Optional flags for the command. [min]


task-lock-list

Returns a list of internal task object locks for the specified storage system. 

 qs task-lock-list|tl-list [--storage-system=value ] [--flags=value ]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


task-lock-release

Releases the specified internal task object locks on the specified storage system (internal support use only, --force flag required). 

 qs task-lock-release|tl-release --task=value [--storage-system=value ] [--flags=value ]
  task ID of a task.
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [force]


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 ] [--flags=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'.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

Trace Level Management [TRACE-LEVEL]

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

event-pulse

Updates object timestamps of the specified type for the specified system to induce event traffic in the grid for testing purposes. 

 qs event-pulse|e-pulse --object-type=value [--storage-system=value ] [--flags=value ]
  object-type Type of the object to associate the tag with. [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, forget-missing, min, *none]


trace-level-get

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

 qs trace-level-get|tl-get [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--event-verbose-filter=value ] [--flags=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. Comma-delimited list of classes, containing optional colon-delimited function names. For example: 'service/osn_foo_util.cpp,service/osn_service_bar.cpp:func1:func2'
  trace-options Specific options for tracing [enable-cpuinfo,disable-cpuinfo,enable-meminfo,disable-meminfo,enable-calllog,disable-calllog,enable-eventlog,disable-eventlog,enable-execlog,disable-execlog,executing,enable-delta-ObjectType,disable-delta-ObjectType]
  event-verbose-filter Specific object types that you would like to have verbose event logging levels. Comma-delimited list of object types, containing optional colon-delimited event types. For example: 'HwEnclosure:modify:add'
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 management User account to the Storage System/Grid. A matching console level account is created on all grid nodes but by default SSH access is blocked. Rather, management accounts enable the use of qs CLI commands and web management interface access as per the limits of the User's assigned 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 ] [--uid=value ] [--gid=value ] [--cli-auth=value ] [--alerts=value ] [--account-type=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--hours-term=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ]
  name User names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
  password Password for the user to use when accessing the Storage System via the web management interface, qs CLI, or REST API.
  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'
  uid POSIX user ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
  gid POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
  cli-auth Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management 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]
  account-type Specifies the account type where standard accounts are the default and emergency/temporary account types are for short-term special situations (see NIST 800-53). These accounts automatically terminate after a specified number of hours. [emergency, *standard, temporary]
  disable-wui-tabs Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
  disable-wui-sections Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
  hours-term Hours until the account is auto-terminated. On termination emergency accounts are locked and temporary accounts are removed/deleted. Unlocking a locked emergency account will add 24 hours to the termination date.
  enable-mfa Enable Multi Factor Authentication for this user at login.
  mfa-config Name or ID of a multi-factor authentication configuration.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


user-app-token-add

Adds a user app token. 

 qs user-app-token-add|u-app-tkn-add --user=value [--name=value ] [--app-key=value ] [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ]
  user Name or ID (GUID) of a existing user.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  app-key Application provider key
  date-token-expires Date on which the token expires.
  read-only-token User app token is read only. Default is read/write
  user-app-token-access-mode User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
  flags Optional flags for the command. [min]


user-app-token-delete

Removes a user app token. 

 qs user-app-token-delete|u-app-tkn-delete --user-app-token=value [--flags=value ]
  user-app-token User app token.
  flags Optional flags for the command. [min]


user-app-token-get

Gets information about the specified user app token. 

 qs user-app-token-get|u-app-tkn-get --user-app-token=value [--flags=value ]
  user-app-token User app token.
  flags Optional flags for the command. [force, min]


user-app-token-list

Returns a list of user app tokens. 

 qs user-app-token-list|u-app-tkn-list [--flags=value ]
  flags Optional flags for the command. [min]


user-app-token-regen

Regenerates a user app token. 

 qs user-app-token-regen|u-app-tkn-regen --user-app-token=value [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ]
  user-app-token User app token.
  date-token-expires Date on which the token expires.
  read-only-token User app token is read only. Default is read/write
  user-app-token-access-mode User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
  flags Optional flags for the command. [min]


user-generate-otp-auth-secret

Generate One-Time-Password (OTP) Authorization secret for the specified user 

 qs user-generate-otp-auth-secret|u-generate-otp-auth-secret --user=value [--flags=value ]
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


user-get

Gets information about the specified user. 

 qs user-get|u-get --user=value [--flags=value ]
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the command. [force, min]


user-list

Returns a list of all the users. 

 qs user-list|u-list [--flags=value ]
  flags Optional flags for the command. [min]


user-modify

Modifies the specified user name, multi-factor authentication settings, role, and/or description. 

 qs user-modify|u-modify --user=value [--role=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--otp-secret-key=value ] [--uid=value ] [--gid=value ] [--lock-account=value ] [--cli-auth=value ] [--alerts=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=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'
  otp-secret-key One-Time-Password (OTP) for multifactor authentication.
  uid POSIX user ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
  gid POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
  lock-account Set to 'true' to lock the account, 'false' to unlock the user account.
  cli-auth Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management 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]
  disable-wui-tabs Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
  disable-wui-sections Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
  enable-mfa Enable Multi Factor Authentication for this user at login.
  mfa-config Name or ID of a multi-factor authentication configuration.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


user-password-set

Changes the password for the specified user 

 qs user-password-set|passwd --user=value --new-password=value [--old-password=value ] [--flags=value ]
  user Name or ID (GUID) of a existing user.
  new-password New password for the User.
  old-password Old password for the User.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


user-remove

Removes the specified user identified by name or ID. 

 qs user-remove|u-remove --user=value [--flags=value ]
  user Name or ID (GUID) of a existing user.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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 ] [--gid=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  user-list A list of one or more users.
  desc A description for the object.
  flags Optional flags for the operation. [async]
  gid POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.


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 [--flags=value ]
  user-group A group of one or more users.
  flags Optional flags for the command. [force, min]


user-group-list

Returns a list of all the storage user groups. 

 qs user-group-list|ug-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--gid=value ] [--flags=value ]
  user-group A group of one or more users.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  gid POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
  flags Optional flags for the command. [async]


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 [--flags=value ]
  user-group A group of one or more users.
  user-list A list of one or more users.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  user-group A group of one or more users.
  user-list A list of one or more users.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]

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-kb=value ] [--stripesize-kb=value ] [--stripe-count=value ] [--qos-policy=value ] [--volume-profile=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--reserved=value ] [--unmapped=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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-kb Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
  stripesize-kb Indicates the stripe unit size for the underlying Ceph RBD.
  stripe-count Indicates the number of objects to write to per stripe before returning to the first object.
  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.
  volume-profile Storage Volume IO Profile settings used to optimize performance for specific use cases.
  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]
  primarycache Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
  secondarycache Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
  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).
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  unmapped Applies only to scale-out (Ceph) block devices, this option disables mapping of the new Storage Volume (RBD) so that it is never connected to the iSCSI/FC/NVMeoF target driver.
  flags Optional flags for the operation. [async, force]


volume-create-passthru

Creates a new Storage Volume using a raw device which is simply passed through to form a Storage Volume. 

 qs volume-create-passthru|v-create-passthru --name=value --disk-list=value [--desc=value ] [--access-mode=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--blocksize-kb=value ] [--qos-policy=value ] [--volume-profile=value ] [--flags=value ]
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  disk-list Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a mulitpath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
  desc A description for the object.
  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.
  blocksize-kb Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
  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.
  volume-profile Storage Volume IO Profile settings used to optimize performance for specific use cases.
  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-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ]
  volume-list A list of one or more Storage Volumes.
  delete-child-snaps-only Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
  delete-child-snaps-and-parent Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
  search-filter Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  dry-run-only Dry run will not delete any shares, only returns a list of shares found by the specified search criteria and options
  flags Optional flags for the operation. [async, force]


volume-get

Returns information about a specific Storage Volume. 

 qs volume-get|v-get --volume=value [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  flags Optional flags for the command. [force, min]


volume-health-check

Checks the health/state of the volume and recursively checks the health of the associated pool and it's disk devices to see if there are any health issues anywhere in the stack. 

 qs volume-health-check|v-check --volume=value [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  flags Optional flags for the operation. [min]


volume-hold-add

Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion. 

 qs volume-hold-add|v-hld-add --volume=value [--hold-tag=value ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  hold-tag Tag identifying the hold.
  flags Optional flags for the operation. [min]


volume-hold-remove

Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion. 

 qs volume-hold-remove|v-hld-remove --volume=value [--hold-tag=value ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  hold-tag Tag identifying the hold.
  flags Optional flags for the operation. [min]


volume-list

Returns a list of all the Storage Volumes. 

 qs volume-list|v-list [--flags=value ]
  flags Optional flags for the command. [min]


volume-modify

Modifies 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 ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--qos-policy=value ] [--volume-profile=value ] [--reserved=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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.
  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 Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system. Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage 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]
  primarycache Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
  secondarycache Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
  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.
  volume-profile Storage Volume IO Profile settings used to optimize performance for specific use cases.
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T


volume-profile-get

Gets information about a specific Storage Volume profile. 

 qs volume-profile-get|vp-get --profile=value [--flags=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.
  flags Optional flags for the command. [force, min]


volume-profile-list

Returns a list of all the Storage Volume profiles. 

 qs volume-profile-list|vp-list [--flags=value ]
  flags Optional flags for the command. [min]


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-search

Returns a subset of Storage Volumes matching the given criteria. 

 qs volume-search|v-search --search-filter=value [--flags=value ]
  search-filter Filter the results of the Storage Volume List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
  flags Optional flags for the command. [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-snapshot-revert

Clears all changes to the snapshot by reverting back to the point-in-time of when the snapshot was originally created. WARNING: Any changes made to the snapshot will be lost. 

 qs volume-snapshot-revert|v-snap-revert --volume=value [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  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 [--flags=value ]
  entry Specifies the GUID or the name of a volume utilization entry in the form of 'VOLUMENAME:TIMESTAMP'
  flags Optional flags for the command. [force, min]


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 ] [--flags=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.
  flags Optional flags for the command. [min]

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 [--lun=value ] [--free-unused-luns=value ] [--flags=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.
  lun FC target Logical Unit Number (LUN) to be applied to the specified Storage Volume. LUN numbers are only relevant to FC access as all iSCSI targets have unique iqns and use LUN 0.
  free-unused-luns Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  host Name of the host or its unique ID (GUID).
  flags Optional flags for the command. [min]


volume-unassign

Disables access to the specific volume from the specified host. 

 qs volume-unassign|va-remove --volume=value --host-list=value [--free-unused-luns=value ] [--flags=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.
  free-unused-luns Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


volume-unassign-all

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

 qs volume-unassign-all|va-remove-all --volume=value [--free-unused-luns=value ] [--flags=value ]
  volume Name of the Storage Volume or its unique ID (GUID).
  free-unused-luns Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI luns are always accessed via unique IQN at LUN 0.
  flags Optional flags for the command. [async, force, forget-missing, 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 only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  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 [--flags=value ]
  volume-group A group of one or more Storage Volumes.
  flags Optional flags for the command. [force, min]


volume-group-list

Returns a list of all the Storage Volume groups. 

 qs volume-group-list|vg-list [--flags=value ]
  flags Optional flags for the command. [min]


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 ] [--flags=value ]
  volume-group A group of one or more Storage Volumes.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  flags Optional flags for the command. [async]


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 [--flags=value ]
  volume-group A group of one or more Storage Volumes.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]


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 [--flags=value ]
  volume-group A group of one or more Storage Volumes.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, forget-missing, min, *none]
Retrieved from "https://wiki.osnexus.com/index.php?title=QuantaStor_CLI_Command_Reference&oldid=25896"