QuantaStor CLI Command Reference v5.6 & 5.7

From OSNEXUS Online Documentation Site
Revision as of 13:22, 14 July 2020 by Qadmin (Talk | contribs)

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

OSNEXUS QuantaStor CLI 5.7.0.109+next-441c050 Copyright (c) 2009-2020 OSNEXUS Corporation. All rights reserved.

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

Contents

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, 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, 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 [--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.
  flags Optional flags for the command. [async, force, min, *none]


alert-clear-all

Clears all the alerts.

 qs alert-clear-all|a-clear-all [--flags=value ] 
  flags Optional flags for the command. [async, force, 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. [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 ] [--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 ] 
  sender-email Sender email address to be used for alert emails sent from the Storage System.
  smtp-server IP Address of the SMTP service where emails should be routed through.
  smtp-port Port number of the SMTP service (eg 25, 465, 587) where emails should be routed through (0 indicates auto-select).
  smtp-user SMTP user name to use for secure SMTP access to your SMTP server for sending alert emails.
  smtp-password SMTP password to use for secure SMTP access to your SMTP server.
  smtp-auth SMTP security mode.
  support-email Email address for local customer support.
  freespace-warning The percentage of free-space left in a pool at which a warning is sent to indicate pool growth plans should be made.
  freespace-alert The percentage (default=10) of free-space left in a pool at which alerts are generated.
  freespace-critical The percentage (default=5) of free-space left in a pool at which all provisioning operations are blocked.
  pagerduty-key Specifies the service key to which alerts will be posted to PagerDuty. Please see www.pagerduty.com for more detail on service keys.
  slack-webhook Slack.com webhook URL for alert messages to be posted to via the Slack webhook API.
  mattermost-webhook Mattermost.org webhook URL for alert messages to be posted to via the Mattermost incoming webhook API.
  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.
  flags Optional flags for the command. [async, force, 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. [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 [--filtered=value ] [--flags=value ] 
  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, 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]


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. [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 ] [--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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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.
  flags Optional flags for the command. [async, force, 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, 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, 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, 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. [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 ] [--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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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 retain-period
  purge-policy Indicates how old files should be cleaned up / purged from the backup. [after-backup, daily, *never, weekly]
  backup-to-root Indicates that the backups should go into the root folder of the Network Share.
  maintain-logs Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
  start-date 2016-12-29T00:00:00Z)
  enabled Set to enabled to activate the backup policy.
  smb-username Specifies the SMB username to use to access the specified remote filer SMB share.
  smb-password Specifies the SMB password to use to access the specified remote filer SMB share.
  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.
  flags Optional flags for the command. [async, force, 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, min, *none]

Scale-out Object / Ceph Management [CEPH]

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

bucket-create

Creates a new S3 bucket in the specified Ceph Cluster.

 qs bucket-create|b-create --name=value --ceph-cluster=value --s3-user=value [--bucket-acl=value ] [--quota-size=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ceph-cluster Ceph Cluster name or ID.
  s3-user Ceph object storage S3 User.
  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)
  flags Optional flags for the command. [async]


bucket-delete

Deletes the specified S3 bucket and all objects contained within.

 qs bucket-delete|b-delete --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. [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. [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 [--desc=value ] [--flags=value ] 
  bucket Name or ID of an S3 object storage bucket.
  desc A description for the object.
  flags Optional flags for the command. [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]


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 of unique ID of a physical network port/target port.
  public-network Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
  cluster-network Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
  flags Optional flags for the operation. [async, force, 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 ] [--enable-osd-compression=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=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. 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.
  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)
  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.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-cluster-delete

Deletes the specified Ceph Cluster.

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


ceph-cluster-fix-clock-skew

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

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


ceph-cluster-get

Gets information about a specific Ceph Cluster.

 qs ceph-cluster-get|cc-get --ceph-cluster=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


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. [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 ] 
  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, 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.


ceph-cluster-remove-member

Remove a Storage System from an existing Ceph Cluster.

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


ceph-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 --service-event-id-list=value [--prune-events=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 events.
  flags Optional flags for the command. [min]


ceph-cluster-service-event-list

Returns a list of ceph cluster service 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 --ceph-crush-rule=value --ceph-cluster=value --ceph-pool-profile=value [--desc=value ] [--flags=value ] 
  ceph-crush-rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  ceph-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 --ceph-crush-rule=value --ceph-cluster=value --ceph-crush-rule-deviceclass=value [--desc=value ] [--ceph-crush-rule-failuredomain=value ] [--ceph-crush-rule-root=value ] [--flags=value ] 
  ceph-crush-rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  ceph-cluster Ceph Cluster name or ID.
  ceph-crush-rule-deviceclass Ceph CRUSH rule device class {'hdd', 'ssd', 'nvme'}
  desc A description for the object.
  ceph-crush-rule-failuredomain Ceph CRUSH rule failure domain { 'osd', 'host', 'rack' } : Default: 'host'
  ceph-crush-rule-root Ceph CRUSH rule, root { Default: '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 --ceph-crush-rule=value [--flags=value ] 
  ceph-crush-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 --ceph-crush-rule=value [--flags=value ] 
  ceph-crush-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-gateway-add

Configures/adds a new S3 Object Storage Gateway (Ceph RGW) on a system within a given Ceph Cluster.

 qs ceph-gateway-add|cgw-add --ceph-cluster=value --ceph-cluster-member=value --gw-ipaddress=value [--gw-port=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-cluster-member Ceph Cluster Member name or ID.
  gw-ipaddress IP address used by S3 Object Storage Gateway (Ceph RGW).
  gw-port Port used by S3 Object Storage Gateway (default:443).
  flags Optional flags for the operation. [async, force, min, *none]


ceph-gateway-get

Gets information about a specific S3 Object Storage Gateway (Ceph RGW).

 qs ceph-gateway-get|cgw-get --ceph-gateway=value [--flags=value ] 
  ceph-gateway S3 Object Storage Gateway (Ceph RGW).
  flags Optional flags for the command. [min]


ceph-gateway-list

Returns a list of all the configured S3 Object Storage Gateways (Ceph RGW).

 qs ceph-gateway-list|cgw-list [--ceph-cluster=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


ceph-gateway-remove

Removes the specified S3 Object Storage Gateway (Ceph RGW).

 qs ceph-gateway-remove|cgw-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]


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=value [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  ceph-cluster-member 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. [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 IPAddress 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. [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-create

Creates a new Ceph OSD on the specified storage pool

 qs ceph-osd-create|osd-create --ceph-cluster=value --data-pool=value --journal-group=value [--quick-format-disks=value ] [--allow-mixed-size-journal-media=value ] [--wal-size=value ] [--db-size=value ] [--desc=value ] [--osd-type=value ] [--weight=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  data-pool Name of the storage pool or its unique ID (GUID) to allocate OSD Data store.
  journal-group Name or ID of the desired associated Journal Group.
  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.
  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.
  desc A description for the object.
  osd-type Ceph osd-type [*auto-select, bluestore, filestore]
  weight Weight associated with the OSD. (default: Auto-configured based on size of Osd).
  flags Optional flags for the operation. [async]


ceph-osd-delete

Deletes the specified Ceph OSD

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


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. [min]


ceph-osd-identify

Identify/blink the specified ceph OSD

 qs ceph-osd-identify|osd-identify --osd-list=value [--blink-type=value ] [--duration=value ] [--flags=value ] 
  osd-list List of one or more ceph-osd.
  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]


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 ] [--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.
  journal-ssd-list List of comma separated SSD disk ID to be used for OSD journal devices during OSD create.
  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.
  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 [*auto-select, bluestore, filestore]
  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 ] [--flags=value ] 
  osd-list List of one or more ceph-osd.
  service-update-mode Ceph OSD service update mode [restart, *start, stop]
  flags Optional flags for the operation. [async]


ceph-pool-create

Creates a new low-level Ceph Pool using the specified OSDs.

 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 ] [--ceph-crush-rule-name=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  ceph-cluster Ceph Cluster name or ID.
  osd-list List of one or more ceph-osd.
  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.
  pool-type Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
  ceph-crush-rule-name Ceph crush map rule set name. (default : 'default', if not specified)
  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. [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 ] [--ceph-crush-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.
  ceph-crush-rule Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [async]


ceph-pool-profile-create

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

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


ceph-pool-profile-delete

Deletes the specified ceph pool profile.

 qs ceph-pool-profile-delete|cpp-delete --ceph-pool-profile=value [--flags=value ] 
  ceph-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  flags Optional flags for the operation. [async]


ceph-pool-profile-get

Gets information about a specific ceph pool profile.

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


ceph-pool-profile-list

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

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


s3-quota-get

Returns details about a specific S3 Quota.

 qs s3-quota-get|s3q-get --bucket-quota=value [--flags=value ] 
  bucket-quota ID of an S3 object storage user/bucket quota.
  flags Optional flags for the command. [min]


s3-quota-list

Returns a list of the S3 Quotas for the specified Ceph Cluster.

 qs s3-quota-list|s3q-list [--ceph-cluster=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  flags Optional flags for the command. [min]


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 Journal Management [CEPHJOURNAL]

Commands for management, monitoring, and configuration of Ceph Journal Groups and Ceph Journal Devices.

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. [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. [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 [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--ceph-crush-rule-name=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.
  pool-type Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
  ceph-crush-rule-name Ceph crush map rule set name. (default : 'default', if not specified)
  flags Optional flags for the operation. [async, force, 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, 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 ] 
  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, min, *none]

Cloud Backup Schedule Management [CLOUD-BACKUP]

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

cloud-backup-schedule-create

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

 qs cloud-backup-schedule-create|cbs-create --name=value --container=value [--volume-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--max-backups=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  container A cloud backup container into which Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  volume-list A list of one or more Storage Volumes.
  start-date 2016-12-29T00:00:00Z)
  enabled While the schedule is enabled snapshots will be taken at the designated times.
  desc A description for the object.
  max-backups Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
  days (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]
  flags Optional flags for the operation. [async]


cloud-backup-schedule-delete

Deletes the specified cloud backup schedule.

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


cloud-backup-schedule-disable

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

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


cloud-backup-schedule-enable

Enables a cloud backup schedule that was previously disabled.

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


cloud-backup-schedule-get

Gets detailed information about a specific cloud backup schedule.

 qs cloud-backup-schedule-get|cbs-get --backup-sched=value [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  flags Optional flags for the command. [min]


cloud-backup-schedule-list

Lists all the cloud backup schedules in the system.

 qs cloud-backup-schedule-list|cbs-list [--flags=value ] 
  flags Optional flags for the command. [min]


cloud-backup-schedule-modify

Modifies the settings for the specified cloud backup schedule.

 qs cloud-backup-schedule-modify|cbs-modify --backup-sched=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--container=value ] [--max-backups=value ] [--days=value ] [--hours=value ] [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  name Names may 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.
  container A cloud backup container into which Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  max-backups Maximum number of backups to do of a given volume in a given backup schedule before the oldest backup is removed.
  days (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]
  flags Optional flags for the operation. [async]


cloud-backup-schedule-trigger

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

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


cloud-backup-schedule-volume-add

Adds Storage Volumes to an existing cloud backup schedule.

 qs cloud-backup-schedule-volume-add|cbs-v-add --backup-sched=value [--volume-list=value ] [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, min, *none]


cloud-backup-schedule-volume-remove

Removes Storage Volumes from an existing cloud backup schedule.

 qs cloud-backup-schedule-volume-remove|cbs-v-remove --backup-sched=value [--volume-list=value ] [--flags=value ] 
  backup-sched A cloud backup schedule periodically does a backup of a specified set of volumes into the cloud.
  volume-list A list of one or more Storage Volumes.
  flags Optional flags for the command. [async, force, min, *none]

Cloud Container Management [CLOUD-CONTAINER]

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

cloud-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 --storage-url=value --container-type=value [--encryption-key=value ] [--enable-nfs=value ] [--attach-to=value ] [--mount-options=value ] [--storage-class=value ] [--flags=value ] 
  provider-creds Credential ID for accessing your cloud storage provider account.
  storage-url The Amazon S3 or other storage URL used to identify a cloud backup container.
  container-type 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]
  encryption-key A passphrase which is used to encrypt all the data sent to the cloud container.
  enable-nfs Enable NFS sharing of the cloud container.
  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)
  flags Optional flags for the command. [async, force, 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, 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 [--desc=value ] [--location=value ] [--attach-to=value ] [--enable-nfs=value ] [--mount-options=value ] [--storage-class=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)
  flags Optional flags for the command. [async, force, 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 Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  delete-cloud-bucket Delete the bucket from the cloud.
  flags Optional flags for the command. [async, force, 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 Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  flags Optional flags for the command. [async, force, 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 Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  flags Optional flags for the command. [async, force, 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 Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  flags Optional flags for the command. [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 Storage Volumes can be backed up. A cloud backup container is like an unlimited storage pool in the cloud.
  flags Optional flags for the command. [async, force, 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, 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. [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, 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. [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. [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]

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-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, 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. [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, min, *none]


disk-global-spare-marker-cleanup

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

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


disk-global-spare-marker-delete

Deletes the specified global hotspare marker object.

 qs disk-global-spare-marker-delete|hsm-del --name=value [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  flags Optional flags for the operation. [async, force, min, *none]


disk-global-spare-marker-get

Returns information about the specified global hotspare marker object.

 qs disk-global-spare-marker-get|hsm-get --name=value [--flags=value ] 
  name Names may 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, 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, 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-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-spare-list

Enumerates dedicated hotspare physical disks in the global hotspare pool.

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


path-list

Enumerates all physical disk paths for multi-path devices.

 qs path-list|pdp-list [--flags=value ] 
  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, min, *none]


grid-analyze-config

Generate a configuration analysis health report of all systems in the grid.

 qs grid-analyze-config|analyze-config [--flags=value ] [--config-category=value ] [--output-format=value ] 
  flags Optional flags for the operation. [async, force, min, *none]
  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 [html, *text]


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, 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, 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. [min]


grid-get-hosts

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

 qs grid-get-hosts|mg-get-hosts [--flags=value ] 
  flags Optional flags for the command. [async, force, min, *none]


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, 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, 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, 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 [--sys-list=value ] [--flags=value ] 
  sys-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async, force, min, *none]


grid-set-hosts

Configures the /etc/hosts configuration file on all systems to include Storage System names.

 qs grid-set-hosts|mg-set-hosts --portid-list=value [--flags=value ] 
  portid-list List of UUIDs for the ethernet ports to be used for grid wide /etc/hosts file configuration.
  flags Optional flags for the operation. [async, force, 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, min, *none]


grid-split

Splits / sub-divides a storage grid into two grids.

 qs grid-split|mg-split --name=value [--sys-list=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  sys-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async, force, 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, 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 ] [--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
  flags Optional flags for the operation. [async, force, 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, 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, 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 [--flags=value ] 
  ha-group Name or UUID of a Storage Pool High-Availability Group
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the operation. [async, force, min, *none]


ha-group-get

Gets information about the specified storage pool HA group

 qs ha-group-get|hag-get --ha-group=value [--flags=value ] 
  ha-group Name or UUID of a Storage Pool High-Availability Group
  flags Optional flags for the command. [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 ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=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.
  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.
  flags Optional flags for the operation. [async, force, 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 ] [--gateway=value ] [--mac-address=value ] [--iscsi-enable=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.
  gateway IP address of the network gateway
  mac-address MAC Address
  iscsi-enable Enables or disables iSCSI access to the specified port(s).
  flags Optional flags for the command. [async, force, 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 [--flags=value ] 
  ha-interface Name or UUID of a Storage Pool High-Availability virtual network interface
  flags Optional flags for the command. [async, force, 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. [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]


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, min, *none]

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. [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, 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. [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, 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. [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, 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, 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, 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. [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, 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, 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. [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. [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, 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, 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, min, *none]


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, 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 [--flags=value ] 
  disk-list Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
  flags Optional flags for the operation. [async, force, 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. [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 [--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.
  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, 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 [--flags=value ] 
  disk-list Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
  flags Optional flags for the operation. [async, force, 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 [--flags=value ] 
  disk-list Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
  flags Optional flags for the operation. [async, force, min, *none]


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 [--flags=value ] 
  disk-list Specifies one or more physical disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
  flags Optional flags for the operation. [async, force, 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. [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. [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. [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-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 ] [--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.
  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, min, *none]


hw-unit-create

Creates a new hardware RAID unit using the specified controller.

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


hw-unit-delete

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

 qs hw-unit-delete|hwu-delete --unit=value [--duration=value ] [--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, 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, 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. [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, 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]

Encryption KeyManagement [KEYVAULT]

Commands for configuration of external Key Management Service to be used for Storage Pool encryption.

keyinfo-list

Get all key information from key vault for the specified Key Vault Profile.

 qs keyinfo-list|key-list --keyvault-profile-id=value [--keytype=value ] [--flags=value ] 
  keyvault-profile-id KeyVault Profile Identifier.
  keytype Encryption key type (root-key, data-encryption-key). [*all-key, data-encryption-key, root-key]
  flags Optional flags for the operation. [min]


keyvault-check-connectivity

Perform a connectivity check for the specified Key Vault Profile from Storage System.

 qs keyvault-check-connectivity|kv-check --keyvault-profile-id=value [--flags=value ] 
  keyvault-profile-id KeyVault Profile Identifier.
  flags Optional flags for the operation. [async, force, min, *none]


keyvault-module-get

Gets information about a specific supported Key Vault Module.

 qs keyvault-module-get|kvm-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. [min]


keyvault-module-list

Returns a list of all the supported Key Vault Modules.

 qs keyvault-module-list|kvm-list [--flags=value ] 
  flags Optional flags for the command. [min]


keyvault-profile-get

Return details about the specified Key Vault Profile configured.

 qs keyvault-profile-get|kvp-get --keyvault-profile-id=value [--flags=value ] 
  keyvault-profile-id KeyVault Profile Identifier.
  flags Optional flags for the command. [min]


keyvault-profile-list

Returns a list of Key Vault Profile(s) configured in the Storage Grid.

 qs keyvault-profile-list|kvp-list [--flags=value ] 
  flags Optional flags for the command. [min]


keyvault-profile-register

Register Key Vault Profile in Storage Grid.

 qs keyvault-profile-register|kvp-register --name=value --grid=value --keyvault-service-api-key=value --keyvault-service-instance-id=value [--desc=value ] [--keyvault-base-address=value ] [--keyvault-iam-address=value ] [--keyvault-module-id=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  grid Name or ID of the Storage System grid.
  keyvault-service-api-key API Key to be used for communicating with the KeyVault.
  keyvault-service-instance-id Unique service Identifier for the application within KeyVault.
  keyvault-base-address Fully qualified address of the KeyVault.
  keyvault-iam-address Fully qualified address of KeyVault IAM server.
  keyvault-module-id KeyVault Module Identifier (Default: 'IBM Key-Protect')
  flags Optional flags for the operation. [async, force, min, *none]


keyvault-profile-unregister

Un-register a previously registered Key Vault Profile in the Storage Grid.

 qs keyvault-profile-unregister|kvp-unregister --keyvault-profile-id=value [--flags=value ] 
  keyvault-profile-id KeyVault Profile Identifier.
  flags Optional flags for the operation. [async, force, min, *none]

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, 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, 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, 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. [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, 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, min, *none]

Cloud I/O Stats Management [METRICS]

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

metrics-get

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

 qs metrics-get|lm-get --storage-system=value [--flags=value ] 
  storage-system Name or ID of a Storage System in a management grid.
  flags Optional flags for the command. [min]


metrics-set

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

 qs metrics-set|lm-set --username=value --token=value [--storage-system=value ] [--interval=value ] [--dashboards=value ] [--alert-anno=value ] [--config-anno=value ] [--flags=value ] 
  storage-system Name or ID of a Storage System in a management grid.
  username The username/email of the Librato Metrics account.
  token The API token associated with the Librato Metrics account.
  interval The interval in seconds of how often a given Storage System should post data to Librato Metrics.
  dashboards Automatically create the Storage System dashboard in Librato Metrics
  alert-anno Add alert annotations to the Librato Metrics postings.
  config-anno Add config annotations to the Librato Metrics postings.
  flags Optional flags for the command. [async, force, min, *none]

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. [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 --preferred-ports=value --share-list=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.
  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.
  flags Optional flags for the command. [async, force, min, *none]


share-namespace-create

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

 qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--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 --preferred-ports=value --share-list=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.
  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.
  flags Optional flags for the command. [async, force, 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 [--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-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 ] [--ssd=value ] [--compress=value ] [--auto-trim=value ] [--nobarriers=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--keyvault-type=value ] [--keyvault-profile=value ] [--encryption-root-key-id=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, 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]
  pool-type The type of storage pool to be created. [ceph-block, ceph-file, swap, xfs, *zfs]
  desc A description for the object.
  is-default Indicates that this pool should be utilized as the default storage pool.
  ssd Enable solid state disk (SSD) storage pool optimizations.
  compress Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
  auto-trim Enable auto-trim storage pool optimizations.
  nobarriers Enable storage pool write optimizations. This requires that you have a hardware controller with a battery backup unit.
  profile Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
  raid-set-size 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. Encryption can only be enabled at the time of pool creation.
  encryption-type Sets the encryption algorithm, currently only the default aes256 is supported. [aes256, *default]
  passphrase Locks up the storage keys into an encrypted file after the pool has been created. After this the passphrase must be provided to start the storage pool. If no storage pool is provided then the pool is started automatically at system startup time.
  keyvault-type KeyVault mode to store the wrapped encryption key. Default "Internal" and "IBM-KeyProtect" are the supported keyvault modes. [IBM-KeyProtect, *default (Internal)]
  keyvault-profile Keyvault profile identifier to uniquely identify the external keyvault configured.
  encryption-root-key-id Encryption root key identifier stored in external keyvault. This root key is used to wrap actual data encryption keys.
  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-mode=value ] [--flags=value ] 
  pool Name of the storage pool or its unique ID (GUID).
  shred-mode Indicates the mode used to shred data on all the disks in the pool as part of the pool destroy process. [dod, nnsa, *none, random, usarmy, zeros]
  flags Optional flags for the operation. [async, force]


pool-device-get

Gets information about a specific storage pool device.

 qs pool-device-get|spd-get --pool-device=value [--flags=value ] 
  pool-device Name or UUID of a storage pool device
  flags Optional flags for the command. [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. [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-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-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 command. [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, 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]
  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 --storage-system=value --pool-list=value [--metadata-only=value ] [--flags=value ] 
  storage-system Name or ID of a Storage System in a management grid.
  pool-list List of storage pools.
  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.
  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 ] [--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.
  flags Optional flags for the operation. [async]


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 ] [--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 ] 
  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.
  ssd Enable solid state disk (SSD) storage pool optimizations.
  compress Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
  auto-trim Enable auto-trim storage pool optimizations.
  nobarriers Enable storage pool write optimizations. This requires that you have a hardware controller with a battery backup unit.
  profile Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
  desc A description for the object.
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  repair-policy assigned-only | assigned-and-global-exact | assigned-only-exact | manual-repair) [*assigned-and-global, assigned-and-global-exact, assigned-only, assigned-only-exact, manual]
  approve-repair Set flag to approve a pending storage pool repair action that is currently deferred and requires explicit manual approval by an operator/admin to proceed
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  flags Optional flags for the operation. [async]


pool-preimport-scan

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

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


pool-profile-get

Gets information about a specific storage pool profile.

 qs pool-profile-get|pp-get --profile=value [--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. [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-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-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. [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 --cloud=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).
  cloud Name of a Storage Cloud or its unique id.
  policy Indicates the type of quota to be created. [hard, *soft]
  desc A description for the object.
  psize The total thin-provisionable space allowed by this provisioning quota.
  usize The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
  max-volumes The maximum number of volumes that can be created using this quota, specify 0 for no limit.
  max-shares The maximum number of share that can be created using this quota, specify 0 for no limit.
  flags Optional flags for the operation. [async]


provisioning-quota-delete

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

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


provisioning-quota-get

Returns information about a specific storage provisioning quota.

 qs provisioning-quota-get|pq-get --quota=value [--flags=value ] 
  quota Name or ID of a storage provisioning quota.
  flags Optional flags for the command. [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 --cloud=value [--name=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--policy=value ] [--flags=value ] 
  quota Name or ID of a storage provisioning quota.
  cloud Name of a Storage Cloud or its unique id.
  name Names may 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, 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, 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, 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, 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, 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. [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, 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, 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, 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, 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 ] [--cloud=value ] [--max-replicas=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 ] 
  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.
  cloud Name of a Storage Cloud or its unique id.
  max-replicas Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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]


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. [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 ] [--cloud=value ] [--max-replicas=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 ] 
  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.
  cloud Name of a Storage Cloud or its unique id.
  max-replicas Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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]


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, min, *none]


replication-schedule-trigger

Triggers the specified schedule to run immediately.

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

Resource Domain Management [RESOURCE-DOMAIN]

Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH) 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, 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-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-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-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-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, 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 [--desc=value ] [--subject-list=value ] [--resource-list=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] 
  name Names may 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...
  parent-cloud The name or unique id of a tenant resource cloud.
  tier The tier of the storage cloud.
  organization The name of the organization this tenant resource cloud is assigned to.
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.
  flags Optional flags for the operation. [async, force, min, *none]


resource-group-delete

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

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


resource-group-get

Returns information of the specified tenant resource groups.

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


resource-group-list

Returns a list of all the tenant resource groups.

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


resource-group-modify

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

 qs resource-group-modify|rg-modify --cloud=value [--name=value ] [--desc=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  name Names may 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, min, *none]


resource-group-resource-add

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

 qs resource-group-resource-add|rgr-add --cloud=value --resource-list=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...
  flags Optional flags for the command. [async, force, min, *none]


resource-group-resource-mode

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

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


resource-group-resource-remove

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

 qs resource-group-resource-remove|rgr-remove --cloud=value --resource-list=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  resource-list A list resources in the following format name:type. Ex: vol:volume,hostname:host...
  flags Optional flags for the command. [async, force, 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|rgsub-alist --subject=value [--flags=value ] 
  subject The unique id of a user or user group.
  flags Optional flags for the operation. [async, force]


resource-group-user-add

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

 qs resource-group-user-add|rgu-add --cloud=value --subject-list=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
  flags Optional flags for the command. [async, force, min, *none]


resource-group-user-remove

Remove one or more users from specified tenant resource group.

 qs resource-group-user-remove|rgu-remove --cloud=value --subject-list=value [--flags=value ] 
  cloud Name of a Storage Cloud or its unique id.
  subject-list A list subjects in the following format name:type. Ex: userName:user,groupName:user_group...
  flags Optional flags for the command. [async, force, 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).

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 ] [--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 ] 
  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)
  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]
  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 ] [--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.
  flags Optional flags for the command. [async, force, 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. [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 ] [--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.
  flags Optional flags for the command. [async, force, 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.
  flags Optional flags for the operation. [async, force, 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.
  flags Optional flags for the operation. [async, force, 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, 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, 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, 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. [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, 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, 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 ] [--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 ] 
  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.
  cloud Name of a Storage Cloud or its unique id.
  max-snaps Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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]


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. [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 ] [--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 ] 
  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.
  cloud Name of a Storage Cloud or its unique id.
  max-snaps Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
  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 checkpoints/snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
  rc-dailies Retention count of daily checkpoints/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 checkpoints/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 checkpoints/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 checkpoints/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]


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, 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, 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 NFS and 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, 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. [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, force]


share-client-list

Returns a list of NFS clients access rules for the specified Network Share.

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


share-client-modify

Modifies a NFS client access rule for the specified Network Share.

 qs share-client-modify|shr-cmodify --share=value --filter=value [--rdonly=value ] [--secure=value ] [--async=value ] [--subtree=value ] [--options=value ] [--flags=value ] 
  share Name or ID of a Network Share.
  filter A filter string for the client
  rdonly Allow only read requests for the NFS volume
  secure Requires the requests to originate from an Internet port less than IPPORT_RESERVED
  async Use asynchronous communication between NFS server and client
  subtree Enables subtree checking
  options Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
  flags Optional flags for the operation. [async, force]


share-client-remove

Removes NFS client access rule for the specified Network Share.

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


share-clone

Creates a full copy of the specified Network Share to another storage pool.

 qs share-clone|shr-clone --share=value --pool=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] 
  share Name or ID of a Network Share.
  pool Name of the storage pool or its unique ID (GUID).
  name Name for the clone, if not provided the source volume name will be used as a prefix.
  desc A description for the object.
  active Indicates that the Network Share should be activated.
  flags Optional flags for the operation. [async, force]


share-create

Creates a new Network Share accessible via NFS v3/v4 and the SMB protocol.

 qs share-create|shr-create --name=value --pool=value [--desc=value ] [--public=value ] [--active=value ] [--cifs-enable=value ] [--user-access-list=value ] [--cifs-options=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--reserved=value ] [--vvol-type=value ] [--protocol-end-point=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]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  disable-snap-browsing When this is true, ability to browse snapshot directories over CIFS is disabled.
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the userAccessList 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 NetworkShare 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.
  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.

 qs share-create-alias|shr-create-alias --name=value --parent-share=value [--subpath=value ] [--inherit-access=value ] [--desc=value ] [--public=value ] [--active=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.
  flags Optional flags for the operation. [async, force]


share-delete

Deletes the specified Network Share

 qs share-delete|shr-delete --share=value [--delete-child-snaps=value ] [--flags=value ] 
  share Name or ID of a Network Share.
  delete-child-snaps Deletes the child snapshots of the specified share/volume.
  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 ] [--flags=value ] 
  share Name or ID of a Network Share.
  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. [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-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 ] [--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)
  flags Optional flags for the operation. [async, force]


share-leave-domain

Leaves the current Active Directory domain.

 qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--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 ] [--flags=value ] 
  vasa-support-only VASA support only.
  flags Optional flags for the command. [min]


share-modify

Modifies the properties of the specified Network Share.

 qs share-modify|shr-modify --share=value [--name=value ] [--desc=value ] [--active=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--cifs-enable=value ] [--user-access-list=value ] [--group-access-list=value ] [--cifs-options=value ] [--disable-snap-browsing=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--is-active-checkpoint=value ] [--reserved=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]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  cifs-enable Enables Samba support for Network Share.
  user-access-list List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3: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.
  disable-snap-browsing When this is true, ability to browse snapshot directories over CIFS is disabled.
  share-owner Name of the share owner
  share-owner-group Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the userAccessList 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 NetworkShare 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
  flags Optional flags for the operation. [async]


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 [--flags=value ] 
  share Name or ID of a Network Share.
  flags Optional flags for the operation. [async, force]


share-rollback

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

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


share-snapshot

Creates and instant space efficient snapshot of the specified Network Share (requires Advanced Storage Pool)

 qs share-snapshot|shr-snap --share=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] 
  share Name or ID of a Network Share.
  name Names may 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.
  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, 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, 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. [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. [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 --sys-list=value [--flags=value ] 
  site A site is a group of appliances in a location.
  sys-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. [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 --sys-list=value [--desc=value ] [--location=value ] [--flags=value ] 
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  sys-list List of systems to be combined together to form a new site.
  desc A description for the object.
  location Optional description indicating the location of the Storage System.
  flags Optional flags for the operation. [async]


site-cluster-delete

Deletes the specified site configuration.

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


site-cluster-get

Returns detailed information about the specified site.

 qs site-cluster-get|sc-get --site=value [--flags=value ] 
  site A site is a group of appliances in a location.
  flags Optional flags for the command. [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 --sys-list=value [--flags=value ] 
  site A site is a group of appliances in a location.
  sys-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async]


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-vif-create

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

 qs site-vif-create|svr-create --site=value --parent-port=value --ip-address=value [--netmask=value ] [--mtu=value ] [--grid-vif=value ] [--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)
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  grid-vif When true, this virtual interface will be the gridIP. The gridIP is used for grid master auto election.
  flags Optional flags for the command. [async, force, 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 [--flags=value ] 
  vif-resource A site virtual interface resource.
  flags Optional flags for the command. [async, force, 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. [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-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 th 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, 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 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 storage tier (pools are not deleted).

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


storage-tier-get

Returns information about a specific storage storage tier.

 qs storage-tier-get|st-get --tier=value [--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. [min]


storage-tier-list

Returns a list of all the storage 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, 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, 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 SAN adapter for connecting to the specified iSCSI SAN.

 qs sw-controller-add|swc-add --ip-address=value --name=value --storage-system=value [--desc=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] 
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  storage-system Name or ID of a Storage System in a management grid.
  desc A description for the object.
  chap-user An optional iSCSI CHAP username.
  chap-pass An optional iSCSI CHAP password.
  flags Optional flags for the command. [async, force, 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 --sys-list=value --volume-list=value [--flags=value ] 
  sys-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, 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. [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

Removed the specified iSCSI 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, min, *none]


sw-controller-scan

Scans the specified iSCSI SAN adapter for iSCSI 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, 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. [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, 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, min, *none]


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. [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]

Object Storage Management [SWIFT]

Commands for S3/SWIFT object storage setup and S3 user management.

ceph-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 ceph-object-pool-group-create|cog-create --ceph-cluster=value --name=value [--desc=value ] [--object-store-zone=value ] [--object-store-region=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--ceph-pool-profile=value ] [--sys-list=value ] [--use-case=value ] [--scaling-factor=value ] [--flags=value ] 
  ceph-cluster Ceph Cluster name or ID.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  desc A description for the object.
  object-store-zone Ceph object storage zone. (Default: 'default')
  object-store-region Ceph object storage region. (Default: 'default')
  pool-type Type of Ceph pool, 'replicated' (mirror based, default) or 'erasure' which is like network RAID5.
  min-replicas Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
  max-replicas Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
  ceph-pool-profile Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
  sys-list List of one or more Storage Systems.
  use-case Default use case is S3 object storage but Openstack based pools may also be created in addition. [*s3, s3+openstack]
  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.
  flags Optional flags for the operation. [async, force, min, *none]


ceph-object-pool-group-delete

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

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


ceph-object-pool-group-get

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

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


ceph-object-pool-group-list

Returns a list of all the object storage pool groups.

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


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, 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. [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, 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, min, *none]


s3-user-create

Creates a new S3 User to allow S3/SWIFT protocol access to the S3 Object Storage Group/Zone.

 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 ] 
  ceph-cluster Ceph Cluster name or ID.
  name Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
  display-name Display name for the user.
  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.
  flags Optional flags for the operation. [async, force, min, *none]


s3-user-delete

Deletes the specified S3 User.

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


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, 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, 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. [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 specifed 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, min, *none]

Storage System Management [SYSTEM]

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

enter-system-maintenance

Set the Storage System(s) in Maintenance mode.

 qs enter-system-maintenance|en-maint --sys-list=value [--enter=value ] [--flags=value ] 
  sys-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, min, *none]


exit-system-maintenance

Get the Storage System(s) out of Maintenance mode.

 qs exit-system-maintenance|ex-maint --sys-list=value [--exit=value ] [--flags=value ] 
  sys-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, min, *none]


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. [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 ] [--log-collection=value ] [--eth-naming=value ] [--protocol-block=value ] [--protocol-block-reset=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]
  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, iscsi, *nfs, restapi, smb]
  protocol-block-reset Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
  flags Optional flags for the operation. [async, force, 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, min, *none]


system-restart

Restarts the entire Storage System.

 qs system-restart|restart --sys-list=value [--flags=value ] 
  sys-list List of one or more Storage Systems.
  flags Optional flags for the operation. [async, force, min, *none]


system-shutdown

Shutdown the Storage System.

 qs system-shutdown|shutdown --sys-list=value [--service-only=value ] [--flags=value ] 
  sys-list List of one or more Storage Systems.
  service-only Shutdown just the management service and not the system.
  flags Optional flags for the operation. [async, force, 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, librato, pool, replication, 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 --sys-list=value [--include-kernel=value ] [--distro-upgrade=value ] [--allow-reboot=value ] [--core-only=value ] [--flags=value ] 
  sys-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.
  flags Optional flags for the operation. [async, force, min, *none]


timezone-list

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

 qs timezone-list|tz-list [--storage-system=value ] [--search-filter=value ] [--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. [min]


tunable-list

Returns a list of all the system performance tunables 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 tunables.

 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. [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, 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, 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. [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, 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 [disk, host, pool, share, user, user-group, *volume]
  flags Optional flags for the command. [async, force, 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, min, *none]


bonded-interface-delete

Deletes the specified bonded network interface.

 qs bonded-interface-delete|bond-delete --port=value [--flags=value ] 
  port Name of unique ID of a physical network port/target port.
  flags Optional flags for the command. [async, force, min, *none]


fiber-channel-port-disable

Disables the specified fiber channel port.

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


fiber-channel-port-enable

Enables the specified fiber channel port.

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


fiber-channel-port-get

Returns information about the specified fiber channel target port.

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


fiber-channel-port-list

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

 qs fiber-channel-port-list|fcp-list [--flags=value ] 
  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. [min]


infiniband-port-list

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

 qs infiniband-port-list|ibp-list [--flags=value ] 
  flags Optional flags for the command. [min]


network-port-disable

Disables the specified target port.

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


network-port-enable

Enables the specified target port.

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


network-port-get

Returns information about the specified target port.

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


network-port-list

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

 qs network-port-list|np-list [--flags=value ] 
  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 ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--object-gateway-enable=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 ] 
  port Name or MAC address of a target port, or 'all' to modify all ports.
  port-type Port configuration type. (static, dhcp)
  ip-address IP Address of the host being added; if unspecified the service will look it up.
  netmask Subnet IP mask (ex: 255.255.255.0)
  gateway IP address of the network gateway
  mtu Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
  iscsi-enable Enables or disables iSCSI access to the specified port(s).
  object-gateway-enable Enables/disables access to the port via S3/SWIFT for object storage deployments. WARNING, turning on object storage access will block management access to the web UI for that IP address!
  desc A description for the object.
  float-list List of physical ports and/or bonded ports that the virtual interface is allowed to float between. If a physical port goes offline the system will automatically float the virtual interface to one of the online physical ports in the float list.
  bond-mode Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [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, iscsi, *nfs, restapi, smb]
  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, iscsi, *nfs, restapi, smb]
  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, 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, min, *none]


network-port-restart

Restarts the specified target port.

 qs network-port-restart|np-restart --port=value [--flags=value ] 
  port Name or MAC address of the target port.
  flags Optional flags for the operation. [async, force, 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, sftp, swift, wasabi-s3]
  flags Optional flags for the operation. [async, force, min, *none]


provider-app-list

List the registered providers.

 qs provider-app-list|prov-app-list [--flags=value ] 
  flags Optional flags for the operation. [async, force, 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, sftp, swift, wasabi-s3]
  flags Optional flags for the operation. [async, force, 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, 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, min, *none]


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, min, *none]


virtual-interface-create

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

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


virtual-interface-delete

Deletes the specified virtual network interface.

 qs virtual-interface-delete|vif-delete --port=value [--flags=value ] 
  port Name of unique ID of a physical network port/target port.
  flags Optional flags for the command. [async, force, min, *none]


virtual-interface-move

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

 qs virtual-interface-move|vif-move --vif=value --port=value [--flags=value ] 
  vif Name of unique ID (GUID) for the virtual interface.
  port Name of unique ID of a physical network port/target port.
  flags Optional flags for the command. [async, force, 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, min, *none]


vlan-interface-delete

Deletes the specified VLAN interface.

 qs vlan-interface-delete|vlan-delete --port=value [--flags=value ] 
  port Name of unique ID of a physical network port/target port.
  flags Optional flags for the command. [async, force, 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, 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, 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. [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 Mmanager 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, 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, min, *none]

Trace Level Management [TRACE-LEVEL]

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

trace-level-get

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

 qs trace-level-get|tl-get [--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]
  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, 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, 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. [Disabled, *Local only, Remote and Local, 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. [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. [Disabled, *Local only, Remote and Local, Remote only]
  flags Optional flags for the command. [min]


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. [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 ] [--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'
  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, 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, 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, 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. [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, 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, 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=value ] [--qos-policy=value ] [--volume-profile=value ] [--sync=value ] [--compression-type=value ] [--copies=value ] [--reserved=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 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.
  sync Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  reserved Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
  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=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 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=value [--delete-child-snaps=value ] [--flags=value ] 
  volume Name of the Storage Volume or its unique ID (GUID).
  delete-child-snaps Deletes the child snapshots of the specified share/volume.
  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. [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-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 a the name, description or other properties of the Storage Volume.

 qs volume-modify|v-modify --volume=value [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=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]
  compression-type off | lzjb | gzip | gzip-[1-9] | zle | lz4)
  copies Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
  qos-policy Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
  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. [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-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. [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 [--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, 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, 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, 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. [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, 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, min, *none]