Storage and Volumes

List disk drives

Print extra information for each element

Display this help and exit

The ID of the disk drive to list. Required unless "--node-name" is specified

The node name. Required unless "--id" is specified

Create logical volume

The physical device path

Force creation will reformat existing volume

Display this help and exit

The node name

Delete logical volume

Display this help and exit

The logical volume ID (Required)

Discover information about logical volume

Display this help and exit

The logical volume ID (Required)

List logical volumes

Print extra information for each element

Display this help and exit

The ID of the logical volume to list. Required unless "--node-name" is specified

The node name. Required unless "--id" is specified

Create a node in the system

Authentication username. This option is mandatory for third-party nodes. This option is mutually exclusive with the cert option

Additional value. Format: key=value

Causes the command to be executed asynchronously. A reference task identifier will be returned

The node’s authentication certificate. This option is mandatory for third-party nodes, and
is mutually exclusive of the access-id and secret options

Create default "place-on", "confine-to" and "exclude-from" objectives for this node

Display this help and exit

Proceed even if the node is configured with IP addresses already in use within the cluster. Warning: if this is used in order to add the same system multiple times, it can cause behavior inconsistencies

Node IP address. This option is mandatory for third-party nodes

The name to assign to the node (Required)

When running a task-based command synchronously, monitor for task completion indefinitely

Lowercase node UUID to use for NFS OTHER nodes only

Authentication password. This option is mandatory for third-party nodes. This option is mutually exclusive with the cert option

Node type (Required)

List all nodes in the system

Print extra information for each element

Display this help and exit

The ID of the node to list

The internal ID of the node to list

The name of the node to list

Filter nodes by name substring (case-sensitive)

Filter nodes by name regular expression pattern

Filter nodes by name prefix (case-sensitive)

Filter nodes by a specific NodeType

List only discovered unauthorized nodes connected to the system

Modify node’s mode

Display this help and exit

Node ID. Required unless any of the following is specified: --internal-id, --name

Node internal ID. Required unless any of the following is specified: --name, --id

Target mode. Possible values: ONLINE | MAINTENANCE | POWEROFF | REBOOT. (Required)

Node name. Required unless any of the following is specified: --internal-id, --id

Refresh a node in the system

Causes the command to be executed asynchronously. A reference task identifier will be returned

Display this help and exit

Node ID. Required unless any of the following is specified: --internal-id, --name

Node internal ID. Required unless any of the following is specified: --name, --id

Node name. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

Remove components from persisted model that have been removed from the node

Rescan disk drives in node

Remove a node from the system. A node that contains system services cannot be removed

Causes the command to be executed asynchronously. A reference task identifier will be returned

Force remove, whether the node is up or down, possibly leaving the node in an irreparable state

Display this help and exit

The ID of the node to remove. Required unless any of the following is specified: --internal-id, --name

The internal ID of the node to remove. Required unless any of the following is specified: --name, --id

The name of the node to remove. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

Repair node storage volumes

Display this help and exit

Node ID to be repaired. Required unless "--name" is specified

Node name to be repaired. Required unless "--id" is specified

Update a node in the system

Authentication username

Additional value. Format: key=value

Causes the command to be executed asynchronously. A reference task identifier will be returned

The node’s authentication certificate

Display this help and exit

Node ID. Required unless any of the following is specified: --internal-id, --name

Node internal ID. Required unless any of the following is specified: --name, --id

Node IP address

Node name. Required unless any of the following is specified: --internal-id, --id

The name to assign to this node

When running a task-based command synchronously, monitor for task completion indefinitely

Authentication password

Configure and view NVMe-oF enclosures and configurations

Connect all targets of the specified NVMe-oF enclosure

Subsystem NQN(s) to connect

Number of seconds to wait for a controller to reconnect before giving up (-1 uses the special no-timeout value)

Disconnect all targets of the specified NVMe-oF enclosure

Subsystem NQN(s) to disconnect

The ID of the DSX node when adding an NVMe-oF enclosure

The internal ID the DSX when adding an NVMe-oF enclosure

The name of the DSX node when adding an NVMe-oF enclosure

Add an NVMe-oF enclosure to a DSX

UUID of enclosure to operate on

The name of the enclosure to be operated on

Remove an NVMe-oF enclosure by name or Id

Print extra information for each element

Display this help and exit

Controller I/O policy. Possible values: ROUND_ROBIN | NUMA | QUEUE_DEPTH.

Number of request/completion queue pairs

List all NVMe-oF enclosures across all DSXs

Maximum number of I/O queue entries

The target(s) and optionally port and transport type when adding or updating an enclosure

Network target port

Network transport type. Possible values: TCP | RDMA.

Discover information about an object logical volume (bucket)

Display this help and exit

The logical volume ID (Required)

Add an object storage node to the product

Object Storage access identifier

Trust the server’s certificate without checking its CA chain

Causes the command to be executed asynchronously. A reference task identifier will be returned

When the product is running in AWS, use the STS token supplied by the EC2 instance for authentication. When this option is enabled, access-id/secret are not required.

Bucket names are prefixed to the hostname (mybucket.example.org)

Create default "place-on", "confine-to" and "exclude-from" objectives for this object storage node

Display this help and exit

The name to assign to the object storage (Required)

When running a task-based command synchronously, monitor for task completion indefinitely

for GOOGLE_CLOUD types, overrides the email suffix found in the access-id for purposes of specifying a project name

Proxy host name/IP

Proxy password

Proxy port

Proxy username

S3 auth signing type. Possible values: S3_DEFAULT_SIGNING | S3_V4_SIGNING.

Object Storage secret

AWS STS token. Only valid for AMAZON_S3. When setting, the access_id and secret must be correct for the token.

Object storage type

Update an object storage node

Object storage access key

Trust the server’s certificate without checking its CA chain

Causes the command to be executed asynchronously. A reference task identifier will be returned

Do not use the STS token supplied by an AWS EC2 instance for authentication

When the product is running in AWS, use the STS token supplied by the EC2 instance for authentication. When this option is enabled, access-id/secret are not required.

Bucket names are suffixed as a path (example.org/mybucket)

Bucket names are prefixed to the hostname (mybucket.example.org)

Validate the server certificate’s CA chain

Reset the endpoint to its default

Display this help and exit

The ID of the object storage to update. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object storage to update. Required unless any of the following is specified: --name, --id

The name of the object storage to update. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

for GOOGLE_CLOUD types, overrides the email suffix found in the access-id for purposes of specifying a project name

Clears the project name override

Remove the proxy definitions, i.e. don’t use proxy for this Object storage

Proxy host name/IP

Proxy password

Proxy port

Proxy username

Object storage secret key

AWS STS token. Only valid for AMAZON_S3. When setting, the access_id and secret must be correct for the token.

Clear the AWS STS token. When clearing, the access_id and secret must be set for use without a token.

Force update even when new configuration may cause object storage volumes to become unusable

Object storage type

Add an object storage volume to the product

Access key, if not provided, the object storage credentials will be used

Volume availability capability, specified as the number of nines (number between 0 and 20)

Create default "place-on", "confine-to" and "exclude-from" objectives for this object volume

Volume durability capability, specified as the number of nines (number between 0 and 20)

Disable coordinated garbage collection. Only applicable for shared object volumes.

Enable coordinated garbage collection. Only applicable for shared object volumes.

Display this help and exit

The percent [0,100] of total capacity which when reached, will trigger the system to begin evacuating data from the volume. When not specified, 75 percent is used

object logical volume ID. Required unless "--logical-volume-name" is specified

object logical volume. Required unless "--logical-volume-id" is specified

When the high threshold is reached and data is moving off of the volume, this is the target percent [0,high threshold] to reach before stopping the evacuation of data. When not specified, the default is the high threshold * 0.8

The amount of time a volume may remain in a SUSPECTED operational state before its storage volume state is automatically transitioned to UNAVAILABLE. May be formatted as 10seconds, 1minute, "1 hour 30 minutes", etc. When no units are specified, minutes are assumed

The object storage volume name. If not provided, a default name will be assigned

Data is stored as non-chunked, unencrypted, and uncompressed.

Do not compress when storing.

Do not encrypt.

The node ID. Required unless "--node-name" is specified

The node name. Required unless "--node-id" is specified

Max time (in nanoseconds) for the file to be restored

Prevents objects with instances on the volume from being aggressively realigned when availability or durability is reduced for the volume.

Secret key, if not provided, the object storage credentials will be used

Indicates that the ownership of the object volume is, or will be, shared with other sites

Storage class for cost-optimized storage tiers. Defaults to STANDARD if not specified. Cannot be changed after creation. Possible values: STANDARD | AWS_GLACIER_INSTANT_RETRIEVAL.

Specifies the total amount of data allowed to be stored on the volume. When not specified, a practically unlimited amount is assumed

Use high compression when storing.

Start the object volume decommission process

Decommission runs as a restartable task, although this command itself is deprecated.

If normal garbage collection is active when decommission cleaning starts, garbage collection is aborted gracefully and the task waits for it to finish before the cleaner starts.

The task then follows the cleaning session:

A failure at this point leaves the object storage volume in DECOMMISSIONING at the cleaning stage. To recover, rerun object-volume-remove. The task-resume command cannot restart a cleaning session that has already ended.

Causes the command to be executed asynchronously. A reference task identifier will be returned

Force decommission, even if it will impact access to data

Display this help and exit

Object Storage Volume ID. Required unless any of the following is specified: --internal-id, --name

Object Storage Volume internal ID. Required unless any of the following is specified: --name, --id

Object Storage Volume name. Required unless any of the following is specified: --internal-id, --id

List of locations to replace the decommissioned volume. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name>

Cancel the object storage volume decommission process

Display this help and exit

Object Storage Volume identifier. Required unless any of the following is specified: --internal-id, --name

Object Storage Volume internal ID. Required unless any of the following is specified: --name, --id

Object Storage Volume name. Required unless any of the following is specified: --internal-id, --id

The ID of the task that is decommissioning the Object Storage Volume

Set an object volume to the FAILED state. Typically used to allow the removal of an object volume that no longer exists

Display this help and exit

The ID of the object volume to set to the FAILED state. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume to set to the FAILED state. Required unless any of the following is specified: --name, --id

The name of the object volume to set to the FAILED state. Required unless any of the following is specified: --internal-id, --id

Start garbage collection on a given object volume.

Display this help and exit

The ID of the object volume. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume. Required unless any of the following is specified: --name, --id

The name of the object volume. Required unless any of the following is specified: --internal-id, --id

Stop garbage collection on a given object volume.

Display this help and exit

The ID of the object volume. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume. Required unless any of the following is specified: --name, --id

The name of the object volume. Required unless any of the following is specified: --internal-id, --id

List object volumes

Print extra information for each element

Display this help and exit

The ID of the volume to list

The internal ID of the volume to list

The name of the volume to list

Remove an object volume from the system. Removal is task-based and first determines whether the volume must be decommissioned. Volumes in OK, UNAVAILABLE, or DECOMMISSIONING state first get decommissioned, then removed. Volumes already in ADDED or DECOMMISSIONED state skip decommissioning and get directly removed. Volumes in FAILED state also skip decommissioning and go straight to being removed, but they also skip the final teardown during removal, so that accidental data-loss is minimized.

If the volume is currently in a FAILED or DECOMMISSIONED state, it will be removed immediately. Otherwise, the volume’s state will transition from DECOMMISSIONING to CLEANING to DECOMMISSIONED before being removed.

Causes the command to be executed asynchronously. A reference task identifier will be returned

Display this help and exit

The ID of the object volume to remove. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume to remove. Required unless any of the following is specified: --name, --id

The name of the object volume to remove. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

List of locations to replace references to the removed object volume with. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name>

Skip validation to ensure that removing this object volume will not negatively impact data replication

Cancel the removal of an object volume. This cancels the active object-volume-remove task while it is still in the cancelable decommission phase. Once the task has advanced into the non-cancelable removal phase, the task will continue to completion instead of rolling back.

Display this help and exit

The ID of the object volume whose removal will be cancelled. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume whose removal will be cancelled. Required unless any of the following is specified: --name, --id

The name of the object volume whose removal will be cancelled. Required unless any of the following is specified: --internal-id, --id

Delete a site’s reservation from an object volume. This is typically done in order to clean up a reservation file left on the object volume when a site has failed or been removed without first removing the object volume. WARNING: deleting a site’s reservation from an object volume where the site is still using that object volume may result in data loss. Before using this command, verify that the site is no longer using the object volume.

Required to acknowledge the potentially destructive nature of this command (Required)

Display this help and exit

The ID of the volume from which to delete the reservation. Required unless any of the following is specified: --internal-id, --name

The internal ID of the volume from which to delete the reservation. Required unless any of the following is specified: --name, --id

The name of the volume from which to delete the reservation. Required unless any of the following is specified: --internal-id, --id

The ID of the site whose reservation is to be deleted. Required unless any of the following is specified: --site-name, --site-internal-id

The internal ID of the site whose reservation is to be deleted. Required unless any of the following is specified: --site-id, --site-name

The name of the site whose reservation is to be deleted. Required unless any of the following is specified: --site-id, --site-internal-id

Mark an unavailable object volume as available

Display this help and exit

The ID of the object volume to mark available. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume to mark available. Required unless any of the following is specified: --name, --id

The name of the object volume to mark available. Required unless any of the following is specified: --internal-id, --id

Mark an object volume as unavailable

Force unavailable, even if it will break existing replication agreements

Display this help and exit

The ID of the object volume to mark unavailable. Required unless any of the following is specified: --internal-id, --name

The internal ID of the object volume to mark unavailable. Required unless any of the following is specified: --name, --id

The name of the object volume to mark unavailable. Required unless any of the following is specified: --internal-id, --id

Update object volume

Access key

Volume availability capability, specified as the number of nines (number between 0 and 20)

Volume durability capability, specified as the number of nines (number between 0 and 20)

Disable coordinated garbage collection. Only applicable for shared object volumes.

Enable coordinated garbage collection. Only applicable for shared object volumes.

Display this help and exit

The percent [0,100] of total capacity which when reached, will trigger the system to begin evacuating data from the volume

Reset the high threshold to its default (75 percent)

object volume ID. Required unless any of the following is specified: --internal-id, --name

object volume internal ID. Required unless any of the following is specified: --name, --id

When the high threshold is reached and data is moving off of the volume, this is the target percent [0,high threshold] to reach before stopping the evacuation of data

Reset the low threshold to its default (20 percent less than the high threshold)

The amount of time a volume may remain in a SUSPECTED operational state before its storage volume state is automatically transitioned to UNAVAILABLE. May be formatted as 10seconds, 1minute, "1 hour 30 minutes", etc. When no units are specified, minutes are assumed

object volume name. Required unless any of the following is specified: --internal-id, --id

object storage new name

Do not compress when storing.

Do not encrypt.

Max time (in nanoseconds) for the file to be restored

Prevents objects with instances on the volume from being aggressively realigned when availability or durability is reduced for the volume.

Allows objects with instances on the volume to be aggressively realigned when availability or durability is reduced for the volume.

Secret key

Specifies the total amount of data allowed to be stored on the volume

Resets the total-capacity to its default

Use the system-configured KMS (if one is configured) for encrypting.

Use high compression when storing.

Add a new bucket or bucket container to an existing S3 server

Access permissions applied to the bucket. Possible values: PUBLIC | GROUP | PRIVATE.

Optional bucket alias

Create a bucket container

Make this bucket container the default for new buckets

Disallow creation of new buckets in a bucket container (allowed by default)

Do not allow this bucket to be deleted, or child buckets to be deleted if creating a bucket container (allowed by default)

Display this help and exit

User that owns the bucket

Additional path below the share root (defaults to '/')

The geographic region for this bucket. If creating a container then this will be the default region for buckets created in the container

ID of an S3 server. Required unless any of the following is specified: --server-name, --server-internal-id

Internal ID of an S3 server. Required unless any of the following is specified: --server-name, --server-id

Name of an S3 server. Required unless any of the following is specified: --server-id, --server-internal-id

ID of a share. Required unless any of the following is specified: --share-internal-id, --share-name

Internal ID of a share. Required unless any of the following is specified: --share-id, --share-name

Name of a share. Required unless any of the following is specified: --share-id, --share-internal-id

Umask for objects created in the bucket

Remove a bucket or bucket container from an S3 server

Delete bucket data

Display this help and exit

Name of bucket or bucket container to remove (Required)

ID of an S3 server. Required unless any of the following is specified: --server-name, --server-internal-id

Internal ID of an S3 server. Required unless any of the following is specified: --server-name, --server-id

Name of an S3 server. Required unless any of the following is specified: --server-id, --server-internal-id

Create an S3 server

Access permissions applied to the bucket. Possible values: PUBLIC | GROUP | PRIVATE.

Make this the default server, only one is allowed at a time

Endpoint prefix, used to support virtual host bucket addressing. Default is 's3'

One or more DNS endpoints for the server. Required unless this is the default server

Display this help and exit

Identity provider for users of this service. Possible values: LOCAL | AD. (Required)

The maximum number of entries to return when listing objects in a bucket, default is 1,000

Multipart uploads will be aborted and cleaned up if initiated this many days ago

Management name for the S3 server (Required)

TCP port(s) to listen on, must be one or both of 80 and 443. Defaults to 443

The default geographic region for buckets

Only list buckets owned by requester, off by default

Enforce AWS bucket name requirements

Umask for objects created in buckets

Delete an S3 server

Display this help and exit

ID of S3 server to delete

Internal ID of S3 server to delete

Name of S3 server to delete

List S3 servers

Print extra information for each element

Display this help and exit

View an S3 server by ID

View an S3 server by internal ID

View an S3 server by name

Update an S3 server

Access permissions applied to buckets. Possible values: PUBLIC | GROUP | PRIVATE.

Remove default ACL

Make this the default server, only one is allowed at a time

Remove default server designation, requires that at least one endpoint is assigned

Endpoint prefix, used to support virtual host bucket addressing. Default is 's3'

Clear the endpoint prefix setting, revert to default 's3'

One or more DNS endpoints for the server. Required unless this is the default server

Remove all endpoints from the server

Display this help and exit

Id of the S3 server to update. Required unless any of the following is specified: --internal-id, --name

Internal Id of the S3 server to update. Required unless any of the following is specified: --name, --id

The maximum number of entries to return when listing objects in a bucket, default is 1,000

Multipart uploads will be aborted and cleaned up if initiated this many days ago

Management name of the S3 server to update. Required unless any of the following is specified: --internal-id, --id

TCP port(s) to listen on, must be one or both of 80 and 443. Defaults to 443

Default geographic region for buckets

Remove default region

Only list buckets owned by requester, off by default

Bucket list will show buckets for all bucket owners

Enforce AWS bucket name requirements

Do not enforce AWS bucket name requirements

Umask for objects created in buckets

Remove any umask set for this server

Add an authorized users to an S3 server

S3 access key for user (Required)

Display this help and exit

S3 secret key for user (Required)

ID of an S3 server. Required unless any of the following is specified: --server-name, --server-internal-id

Internal ID of an S3 server. Required unless any of the following is specified: --server-name, --server-id

Name of an S3 server. Required unless any of the following is specified: --server-id, --server-internal-id

Name of AD or local user to add (Required)

Remove user from an S3 server

Display this help and exit

ID of an S3 server. Required unless any of the following is specified: --server-name, --server-internal-id

Internal ID of an S3 server. Required unless any of the following is specified: --server-name, --server-id

Name of an S3 server. Required unless any of the following is specified: --server-id, --server-internal-id

Name of the AD or local user to remove (Required)

Add a storage volume to the product

The access type of the storage volume. Possible values: READ_ONLY | READ_WRITE.

Allows specification of addresses which are not listed among the logical volume’s IP addresses and which may be used to access data on the volume. This is a comma-separated tuple consisting of: IP, port, transport, node-num, stripe-class, failover-class (where port, transport, node-num, stripe-class and failover-class are optional). The IP may be in CIDR format. The transport may be one of: tcp, tcp6, rdma, rdma6. The node-num allows grouping of IPs which are common to a physical node. The stripe-class allows grouping of IPs which may be used to access the same instance stripe. When omitted, striping is not enabled via this address The failover-class allows grouping of IPs which may be used interchangeably for node failover. A value may be omitted by leaving it empty. 10.20.30.40,,rdma,1 is an example where the port, stripe-class and failover-class are omitted. This parameter may be repeated

Assimilate data from the volume

Causes the command to be executed asynchronously. A reference task identifier will be returned

The storage volume availability capability, specified as the number of nines (number between 0 and 20)

Causes the volume’s advertised availability to other components to drop to zero when the volume’s storage volume state becomes UNAVAILABLE. This has the effect of causing files with instances on the volume to be re-mirrored/moved

Estimated cost of the storage volume

Create default "place-on", "confine-to" and "exclude-from" objectives for this storage volume

The path within the share into which data is assimilated

Disable support for performing offloaded cloning on the volume

The storage volume durability capability, specified as the number of nines (number between 0 and 20)

Exclude the volume from the calculation of the cluster’s free capacity

A comma-separated list of IP addresses and/or ranges (x.x.x.x-y.y.y.y) to exclude from the list of discovered IP addresses

Delete a previous installation’s data from the volume

Display this help and exit

The percent [0,100] of total capacity which when reached, will trigger the system to begin evacuating data from the volume. When not specified, 75 percent is used

Causes assimilation to log data into <share/mount/path>/assimilation-logs-<date>/

The logical volume ID. Required unless "--logical-volume-name" is specified

The logical volume name. Required unless "--logical-volume-id" is specified

When the high threshold is reached and data is moving off of the volume, this is the target percent [0,high threshold] to reach before stopping the evacuation of data. When not specified, the default is the high threshold * 0.8

The amount of time a volume may remain in a SUSPECTED operational state before its storage volume state is automatically transitioned to UNAVAILABLE. May be formatted as 10seconds, 1minute, "1 hour 30 minutes", etc. When no units are specified, minutes are assumed

The storage volume name. If not provided, default name will be assigned

When running a task-based command synchronously, monitor for task completion indefinitely

The node ID. Required unless "--node-name" is specified

The node name. Required unless "--node-id" is specified

The path within the share into which data is assimilated

Disable random writes for the volume

The storage volume read bandwidth (in kb/sec)

The storage volume read number of IOPS

The storage volume read latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

Prevents objects with instances on the volume from being aggressively realigned when availability or durability is reduced for the volume.

The ID of the share into which data is assimilated

The name of the share into which data is assimilated

Do not verify the configuration of the volume being added

Skip file access test when assimilating data from the volume

Do not calculate performance metrics while adding the volume

An Active Directory group to use for SID mapping if a group SID does not have a mapping (because the group has been deleted). Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

An Active Directory user to use for SID mapping if a user SID does not have a mapping (because the account has been deleted). Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

Password for SMB username used to assimilate SMB data

A UNC-style path (e.g. //example.com/Share/path/to/data) which must include the fully-qualified domain name of the SMB server from which data is being assimilated as well as the SMB share name from which data is being assimilated. It may also contain an SMB source path for cases where the SMB source path differs from the NFS path specified in the source-path parameter

SMB username used to assimilate SMB data. Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

The path within the volume from which data is assimilated (the named directory will itself be assimilated). This is used as the NFS source path, and when doing SMB assimilation, and the UNC-style smb_path is missing the path part, this is also used as the SMB source path

The stripe alignment size in bytes when striping is supported. When specified, there should be at least two different stripe-class values among the effective addresses (use additional-ip to specify stripe classes)

Sets the stripe alignment to the default value for the volume

The storage volume tolerable read latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

The storage volume tolerable write latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

The storage volume write bandwidth (in kb/sec)

The storage volume write number of IOPS

The storage volume write latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

Assimilate an existing storage volume

Causes the command to be executed asynchronously. A reference task identifier will be returned

The path within the share into which data is assimilated

Display this help and exit

The volume ID. Required unless any of the following is specified: --internal-id, --name

The internal ID of the volume. Required unless any of the following is specified: --name, --id

Causes assimilation to log data into <share/mount/path>/assimilation-logs-<date>/

The volume name. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

The path within the share into which data is assimilated

The ID of the share into which data is assimilated. Required unless "--share-name" is specified

The name of the share into which data is assimilated. Required unless "--share-id" is specified

Skip file access test when assimilating data from the volume

An Active Directory group to use for SID mapping if a group SID does not have a mapping (because the group has been deleted). Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

An Active Directory user to use for SID mapping if a user SID does not have a mapping (because the account has been deleted). Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

Password for SMB username used to assimilate SMB data

A UNC-style path (e.g. //example.com/Share/path/to/data) which must include the fully-qualified domain name of the SMB server from which data is being assimilated as well as the SMB share name from which data is being assimilated. It may also contain an SMB source path for cases where the SMB source path differs from the NFS path specified in the source-path parameter

SMB username used to assimilate SMB data. Valid forms are <name>@<domain>, <domain>\\<name> or <name>. If <name> is used, the current AD domain is assumed.

The path within the volume from which data is assimilated (the named directory will itself be assimilated). This is used as the NFS source path, and when doing SMB assimilation, and the UNC-style smb_path is missing the path part, this is also used as the SMB source path

Cancel a running assimilation

Display this help and exit

The task ID associated with the running assimilation (Required)

Start the storage volume decommission process

Causes the command to be executed asynchronously. A reference task identifier will be returned

Display this help and exit

Storage Volume identifier. Required unless any of the following is specified: --internal-id, --name

Storage Volume internal identifier. Required unless any of the following is specified: --name, --id

Storage Volume name. Required unless any of the following is specified: --internal-id, --id

List of locations to replace the decommissioned volume. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name>

Cancel the storage volume decommission process

Display this help and exit

Storage Volume identifier. Required unless any of the following is specified: --internal-id, --name

Storage Volume internal identifier. Required unless any of the following is specified: --name, --id

Storage Volume name. Required unless any of the following is specified: --internal-id, --id

The ID of the task that is decommissioning the Storage Volume

Set a storage volume to the FAILED state. Typically used to allow the removal of a storage volume that no longer exists. The FAILED state is terminal, meaning that the data on the volume will be lost, and the volume cannot be reused.

Display this help and exit

The ID of the storage volume to set to the FAILED state. Required unless any of the following is specified: --internal-id, --name

The internal ID of the storage volume to set to the FAILED state. Required unless any of the following is specified: --name, --id

The name of the storage volume to set to the FAILED state. Required unless any of the following is specified: --internal-id, --id

Create a new volume group

The volume group’s description

The volume group expression(s). Expressions are separated by '&'

Display this help and exit

The volume group name (Required)

Delete a volume group

Display this help and exit

The ID of the volume group to delete. Required unless any of the following is specified: --internal-id, --name

The internal ID of the volume group to delete. Required unless any of the following is specified: --name, --id

The name of the volume group to delete. Required unless any of the following is specified: --internal-id, --id

Display a detailed list of all volume groups available in the system

Print extra information for each element

Display this help and exit

The ID of the volume group to list

The internal ID of the volume group to list

The name of the volume group to list

Update a volume group

The volume group’s description. Required unless any of the following is specified: --expressions, --expressions-clear, --new-name, --description-clear

Clear the volume group’s description. Required unless any of the following is specified: --expressions, --expressions-clear, --description, --new-name

The volume group expression(s). Expressions are separated by '&'. Required unless any of the following is specified: --expressions-clear, --description, --new-name, --description-clear

Clear the volume group expression(s). Required unless any of the following is specified: --expressions, --description, --new-name, --description-clear

Display this help and exit

The ID of the volume group to update. Required unless any of the following is specified: --internal-id, --name

The internal ID of the volume group to update. Required unless any of the following is specified: --name, --id

The name of the volume group to update. Required unless any of the following is specified: --internal-id, --id

The volume group updated name. Required unless any of the following is specified: --expressions, --expressions-clear, --description, --description-clear

Display a detailed list of all storage volumes available in the system. Two types of lists can be displayed: a detailed list and a Summary list (default)

Print extra information for each element

Display this help and exit

The ID of the storage volume to list

The internal ID of the volume to list

The name of the storage volume to list

Remove a storage volume from the system. Removal is task-based and first determines whether the volume must be decommissioned. Volumes in OK, UNAVAILABLE, or DECOMMISSIONING state first get decommissioned, then removed. Volumes already in ADDED or DECOMMISSIONED state skip decommissioning and get directly removed. Volumes in FAILED state also skip decommissioning and go straight to being removed, but they also skip the final teardown during removal, so that accidental data-loss is minimized.

If the volume is currently in a FAILED or DECOMMISSIONED state, it will be removed immediately. Otherwise, the volume’s state will transition from DECOMMISSIONING to CLEANING to DECOMMISSIONED before being removed.

Causes the command to be executed asynchronously. A reference task identifier will be returned

Display this help and exit

The ID of the storage volume to remove. Required unless any of the following is specified: --internal-id, --name

The internal ID of the storage volume to remove. Required unless any of the following is specified: --name, --id

The name of the storage volume to remove. Required unless any of the following is specified: --internal-id, --id

When running a task-based command synchronously, monitor for task completion indefinitely

List of locations to replace references to the removed storage volume with. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name>

Cancel the removal of a storage volume. This cancels the active volume-remove task while it is still in the cancelable decommission phase. Once the task has advanced into the non-cancelable removal phase, the task will continue to completion instead of rolling back.

Display this help and exit

The ID of the storage volume whose removal will be cancelled. Required unless any of the following is specified: --internal-id, --name

The internal ID of the storage volume whose removal will be cancelled. Required unless any of the following is specified: --name, --id

The name of the storage volume whose removal will be cancelled. Required unless any of the following is specified: --internal-id, --id

Mark an unavailable storage volume as available

Display this help and exit

The ID of the storage volume to mark available. Required unless any of the following is specified: --internal-id, --name

The internal ID of the storage volume to mark available. Required unless any of the following is specified: --name, --id

The name of the storage volume to mark available. Required unless any of the following is specified: --internal-id, --id

Mark a storage volume as unavailable

Display this help and exit

The ID of the storage volume to mark unavailable. Required unless any of the following is specified: --internal-id, --name

The internal ID of the storage volume to mark unavailable. Required unless any of the following is specified: --name, --id

The name of the storage volume to mark unavailable. Required unless any of the following is specified: --internal-id, --id

Update storage volume attributes, including the volume performance and availability attributes

Add an address which is listed among the logical volume’s IP addresses and which may be used to access data on the volume. This is a comma-separated tuple consisting of: IP, port, transport, node-num, stripe-class, failover-class (where port, transport, node-num, stripe-class and failover-class are optional). The IP may be in CIDR format. The transport may be one of: tcp, tcp6, rdma, rdma6. The node-num allows grouping of IPs which are common to a physical node. The stripe-class allows grouping of IPs which may be used to access the same instance stripe. When omitted, striping is not enabled via this address The failover-class allows grouping of IPs which may be used interchangeably for node failover. A value may be omitted by leaving it empty. 10.20.30.40,,rdma,1 is an example where the port, stripe-class and failover-class are omitted. This parameter may be repeated

Remove a value from the list of additional IP addresses. The format is the same as that for additional-ip-add, but the port and transport are not optional. This parameter may be repeated

Remove all values from the list of additional IP addresses

The storage volume availability capability, specified as the number of nines (number between 0 and 20)

Causes the volume’s advertised availability to other components to remain unaltered when the volume’s storage volume state becomes UNAVAILABLE.

Causes the volume’s advertised availability to other components to drop to zero when the volume’s storage volume state becomes UNAVAILABLE. This has the effect of causing files with instances on the volume to be re-mirrored/moved

Disallow offloaded cloning from being performed on the volume, whether supported or not

The storage volume durability capability, specified as the number of nines (number between 0 and 20)

Allow offloaded cloning to be performed on the volume when supported

Exclude the volume from the calculation of the cluster’s free capacity

Stop excluding the volume from the calculation of the cluster’s free capacity

A comma-separated list of IP addresses and/or ranges (x.x.x.x-y.y.y.y) to be added to the list of excluded IP addresses

A comma-separated list of IP addresses and/or ranges (x.x.x.x-y.y.y.y) to be removed from the list of excluded IP addresses

Remove all values from the list of excluded IP addresses

Display this help and exit

The percent [0,100] of total capacity which when reached, will trigger the system to begin evacuating data from the volume

Reset the high threshold to its default (75 percent)

The ID of the storage volume to update. Required unless any of the following is specified: --internal-id, --name, --volume-group-internal-id, --volume-group-name, --volume-group-id

The internal ID of the storage volume to update. Required unless any of the following is specified: --name, --volume-group-internal-id, --id, --volume-group-name, --volume-group-id

When the high threshold is reached and data is moving off of the volume, this is the target percent [0,100] to reach before stopping the evacuation of data

Reset the low threshold to its default (20 percent less than the high threshold)

The amount of time a volume may remain in a SUSPECTED operational state before its storage volume state is automatically transitioned to UNAVAILABLE. May be formatted as 10seconds, 1minute, "1 hour 30 minutes", etc. When no units are specified, minutes are assumed.

The name of the storage volume to update. Required unless any of the following is specified: --internal-id, --volume-group-internal-id, --id, --volume-group-name, --volume-group-id

The storage volume new name

Disable random writes for the volume

Enable random writes for the volume

The storage volume read bandwidth (in kb/sec)

The storage volume read number of IOPS

The storage volume read latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

Prevents objects with instances on the volume from being aggressively realigned when availability or durability is reduced for the volume.

Allows objects with instances on the volume to be aggressively realigned when availability or durability is reduced for the volume.

The stripe alignment size in bytes when striping is supported. When specified, there should be at least two different stripe-class values among the effective addresses (use additional-ip to specify stripe classes)

Clear the stripe alignment size (disable striping)

Sets the stripe alignment to the default value for the volume

The storage volume tolerable read latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

The storage volume tolerable write latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s

The ID a volume group which represents all volumes to be updated. Required unless any of the following is specified: --internal-id, --volume-group-internal-id, --name, --volume-group-name, --id

The internal ID of a volume group which represents all volumes to be updated. Required unless any of the following is specified: --internal-id, --name, --volume-group-name, --id, --volume-group-id

The name of a volume group which represents all volumes to be updated. Required unless any of the following is specified: --internal-id, --volume-group-internal-id, --name, --id, --volume-group-id

The storage volume write bandwidth (in kb/sec)

The storage volume write number of IOPS

The storage volume write latency. An integer or decimal number, optionally followed by one of [ns, us, ms, s]. If a time unit is not explicitly provided, it is assumed to be in milliseconds. The value will be displayed in milliseconds, rounded to six decimal places. Examples: 5, 5ms, 20000ns, 1009.98us, 0.0046s