Storage and Volumes
drive-list
Usage: drive-list [options]
List disk drives
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| *--id | The ID of the disk drive to list. Required unless "--node-name" is specified |
| *--node-name | The node name. Required unless "--id" is specified |
logical-volume-create
Usage: logical-volume-create [options]
Create logical volume
| Options | Descriptions |
|---|---|
| --device-path | The physical device path |
| --force |
Force creation will reformat existing volume |
| --help |
Display this help and exit |
| --node-name | The node name |
logical-volume-delete
Usage: logical-volume-delete [options]
Delete logical volume
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --id | The logical volume ID |
logical-volume-discover
Usage: logical-volume-discover [options]
Discover information about logical volume
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --id | The logical volume ID |
logical-volume-list
Usage: logical-volume-list [options]
List logical volumes
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| *--id | The ID of the logical volume to list. Required unless "--node-name" is specified |
| *--node-name | The node name. Required unless "--id" is specified |
node-add
Usage: node-add [options]
Add a storage system (such as a file server or NAS device), DSX or Anvil node
| Options | Descriptions |
|---|---|
| --additional-info | Additional value. Format: key=value |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --cert | The node's authentication certificate. This option is mandatory for third-party nodes, and is mutually exclusive of a username/password) |
| --help |
Display this help and exit |
| --ip | Node IP address. This option is mandatory for third-party nodes |
| *--name | The name to assign to the node |
| --password | Authentication password. This option is mandatory for third-party nodes. The cert option must accompany this option |
| *--type | Node type. Possible values: PD | NETAPP_CMODE | NETAPP_7MODE | NETAPP_CLOUD | EMC_ISILON | EMC_VNX | EMC_UNITY | GOOGLE_CLOUD_FILESTORE | SOFTNAS_CLOUD | WINDOWS_FILE_SERVER | OTHER. |
| --username | Authentication username This option is mandatory for third-party nodes. The cert option must accompany this option |
node-list
Usage: node-list [options]
List all storage systems, DSX and Anvil nodes in the cluster
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --id | The ID of the node to list |
| --name | The name of the node to list |
| --unauthorized | List only discovered unauthorized nodes connected to the system |
node-mode-change
Usage: node-mode-change [options]
Change the mode of a storage system, DSX or Anvil node
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | Node ID. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | Node internal ID. Required unless "--id" or "--name" is specified |
| *--mode | Target mode. Possible values: ONLINE | MAINTENANCE | POWEROFF | REBOOT. |
| *--name | Node name. Required unless "--id" or "--internal-id" is specified |
node-refresh
Usage: node-refresh [options]
Refresh the state of a storage system, DSX or Anvil node
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help |
Display this help and exit |
| *--id | Node ID. Required unless "--name" is specified |
| *--name | Node name. Required unless "--id" or "--internal-id" is specified |
| --rescan | Rescan disk drives in node |
node-remove
Usage: node-remove [options]
Remove a storage system, DSX or Anvil node from the cluster. A node that provides system services cannot be removed,
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --force | Force remove, even if the node is down |
| --help |
Display this help and exit |
| *--id | The ID of the node to remove. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the node to remove. Required unless "--id" or "--name" is specified |
| *--name | The name of the node to remove. Required unless "-- id" or "--internal-id" is specified |
node-storage-repair
Usage: node-storage-repair [options]
Repair the storage volumes on a DSX or Anvil node
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | Node ID to be repaired. Required unless "--name" is specified |
| *--name | Node name to be repaired. Required unless "--id" is specified |
node-update
Usage: node-update [options]
Update the authentication credentials for a storage system, DSX or Anvil node
| Options | Descriptions |
|---|---|
| --additional-info | Additional value. Format: key=value |
| --cert | The node's authentication certificate |
| --help |
Display this help and exit |
| *--id | Node ID. Required unless "--name" is specified |
| --ip | Node IP address |
| *--internal-id | Node internal ID. Required unless "--id" or "--name" is specified |
| *--name | Node name. Required unless "--id" is specified |
| --password | Authentication password |
| --username | Authentication usernameobject-volum |
object-logical-volume-discover
Usage: object-logical-volume-discover [options]
Discover information about an object logical volume (bucket)
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | The logical volume ID |
object-storage-add
Usage: object-storage-add [options]
Add an object storage node to the product
| Options | Descriptions |
|---|---|
| * --access-key | Object storage access key |
| --allow-self-signed-certificate | Trust the server's certificate without checking its CA chain |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --bucket-naming-virtual-host | Bucket names are prefixed to the hostname (mybucket.myhost.org) |
| --endpoint | * Object storage endpoint. Required unless --type specifies AMAZON_S3, AZURE, or GOOGLE_CLOUD |
| --help |
Display this help and exit |
| *--name | The name to assign to the object storage |
| --proxy-host | Proxy host name/IP |
| --proxy-password | Proxy password |
| --proxy-port | Proxy port |
| --proxy-username | Proxy username |
| --s3-singing-type | S3 auth signing type. Possible values: S3_DEFAULT_SIGNING | S3_V4_SIGNING. |
| *--secret-key | Object storage secret key |
| --type | Object storage type. Possible values: AMAZON_S3 | ACTIVE_SCALE_S3 | IBM_S3 | CLOUDIAN_S3 | ECS_S3 | GENERIC_S3 | GOOGLE_S3 | SCALITY_S3 | STORAGE_GRID_S3 | AZURE | GOOGLE_CLOUD | HCP_S3. |
object-storage-update
Usage: object-storage-update [options]
Update an object storage node
| Options | Descriptions |
|---|---|
| * --access-key | Object storage access key |
| --allow-self-signed-certificate | Trust the server's certificate without checking its CA chain |
| --bucket-naming-path-style | Bucket names are suffixed as a path (myhost.org/mybucket) |
| --bucket-naming-virtual-host | Bucket names are prefixed to the hostname (mybucket.myhost.org) |
| --disallow-self-signed-certificate | Validate the server certificate's CA chain |
| --endpoint | * Object storage endpoint. Required unless --type specifies AMAZON_S3, AZURE, or GOOGLE_CLOUD |
| --endpoint-clear | Reset the endpoint to its default |
| --help | Display this help and exit |
| *--id | The ID of the object storage to update. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the object storage to update. Required unless "--id" or "--name" is specified |
| *--name | The name of the object storage to update. Required unless "--id" or "--internal-id" is specified |
| --proxy-clear | Remove the proxy definitions, i.e. don't use proxy for this Object storage |
| --proxy-host | Proxy host name/IP |
| --proxy-password | Proxy password |
| --proxy-port | Proxy port |
| --proxy-username | Proxy username |
| --secret-key | Object storage secret key |
| --type | Object storage type. Possible values: AMAZON_S3 | ACTIVE_SCALE_S3 | IBM_S3 | CLOUDIAN_S3 | ECS_S3 | GENERIC_S3 | GOOGLE_S3 | SCALITY_S3 | STORAGE_GRID_S3 | AZURE | GOOGLE_CLOUD | HCP_S3 WASABI_S3 | NETAPP_S3. |
object-volume-add
Usage: object-volume-add [options]
Add an object storage volume to the product
| Options | Descriptions |
|---|---|
| --access-key | Access key, if not provided, the object storage credentials will be used |
| --availability | Volume availability capability, specified as the number of nines (number between 1 and 11) |
| --durability | Volume durability capability, specified as the number of nines (number between 1 and 11) |
| --help | Display this help and exit |
| * --logical-volume-id | object logical volume ID. Required unless "--logical-volume-name" is specified |
| * --logical-volume-name | object logical volume. Required unless "--logical-volume-id" is specified |
| --max-suspected-time | 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. |
| --name | The object storage volume name. If not provided, a default name will be assigned |
| --native | Data is stored as non-chunked, unencrypted, and uncompressed |
| --no-compression | Do not compress when storing |
| * --node-id | The node ID. Required unless "--node-name" is specified |
| * --node-name | The node name. Required unless "--node-id" is specified |
| --online-delay | Max time (in nano-seconds) for the file to be restored |
| --secret-key | Secret key, if not provided, the object storage credentials will be used |
| --shared | Allows an object storage volume already reserved by another Anvil to be added |
object-volume-decommission
Usage: object-volume-decommission [options]
Start the object storage volume decommission process
| Options | Descriptions |
|---|---|
| --force | Force decommission, even if it will impact access to data |
| --help |
Display this help and exit |
| *--id | Object Storage Volume ID. Required unless "--name" or "--internal-id" is specified |
| *--inernal-id | Object Storage Volume internal ID. Required unless "--id" or "--name" is specified |
| *--name | Object Storage Volume name. Required unless "--id" or "--internal-id" is specified |
| --replace-with | List of locations to replace the decommissioned volume. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name> |
object-volume-decommission-cancel
Usage: object-volume-decommission-cancel [options]
Cancel the object storage volume decommission process
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | Object Storage Volume identifier. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | Object Storage Volume internal ID. Required unless "--id" or "--name" is specified |
| *--name | Object Storage Volume name. Required unless "--id" or "--internal-id" is specified |
object-volume-fail
Usage: object-volume-fail [options]
Fail the object storage volume
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | The ID of the object storage volume to fail. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the object storage volume to fail. Required unless "--id" or "--name" is specified |
| *--name | The name of the object storage volume to fail. Required unless "--id" or "--internal-id" is specified |
object-volume-list
Usage: object-volume-list [options]
List object storage volumes
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --id | The ID of the volume to list |
| --internal-id | The internal ID of the volume to list |
| --name | The name of the volume to list |
object-volume-remove
Usage: object-volume-remove [options]
Remove an object storage volume from the system. The object storage volume must be in the DECOMMISSIONED or FAILED state
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | The ID of the object storage volume to remove. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the object storage volume to remove. Required unless "--id" or "--name" is specified |
| *--name | The name of the object storage volume to remove. Required unless "--id" or "--internal-id" is specified |
object-volume-set-available
Usage: object-volume-set-available [options]
Mark an unavailable object storage volume as available
| Options | Descriptions |
|---|---|
| --force | Force unavailable, even if it will break existing replication agreements |
| --help |
Display this help and exit |
| *--id | The ID of the object storage volume to mark available. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the object storage volume to mark available. Required unless "--id" or "--name" is specified |
| *--name | The name of the object storage volume to mark available. Required unless "--id" or "--internal-id" is specified |
object-volume-set-unavailable
Usage: object-volume-set-unavailable [options]
Mark an object storage volume as unavailable
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--id | The ID of the object storage volume to mark unavailable. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the object storage volume to mark available. Required unless "--id" or "--name" is specified |
| *--name | The name of the object storage volume to mark available. Required unless "--id" or "--internal-id" is specified |
object-volume-update
Usage: object-volume-update [options]
Update object storage volume
| Options | Descriptions |
|---|---|
| * --access-key | Access key |
| --availability | Volume availability capability, specified as the number of nines (number between 1 and 11) |
| --durability | Volume durability capability, specified as the number of nines (number between 1 and 11) |
| --help | Display this help and exit |
| *--id | object storage volume ID. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | object storage volume internal ID. Required unless "--id" or "--name" is specified |
| --max-supspected-time | 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. |
| *--name | object storage volume name. Required unless "--id" or "--internal-id" is specified |
| --new-name | object storage new name |
| --no-compression | Do not compress when storing |
| --online-delay | Max time (in nano-seconds) for the file to be restored |
| *--secret-key | Secret key |
| --use-high-compression | Use high compression when storing |
volume-add
Usage: volume-add [options]
Add a storage volume to the product
| Options | Descriptions |
|---|---|
| --access-type | The access type of the storage volume Possible values: READ_ONLY | READ_WRITE. |
| --assimilation | Assimilate data from the volume |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --availability | The storage volume availability capability, specified as the number of nines (number between 1 and 11) |
| --cost | Estimated cost of the storage volume |
| --destination-path | The path within the share into which data is assimilated |
| --disable-offloaded-cloning | Disable support for performing offloaded cloning on the volume |
| --durability | The storage volume durability capability, specified as the number of nines (number between 1 and 11) |
| --excluded-ip | 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 |
| --force | Delete a previous installation's data from the volume |
| --help | Display this help and exit |
| --log-assimilation | Causes assimilation to log data into <share/mount/path>/assimilation-logs-<date>/ |
| * --logical-volume-id | The logical volume ID. Required unless "--logical-volume-name" is specified |
| * --logical-volume-name | The logical volume name. Required unless "--logical-volume-id" is specified |
| --max-suspected-time | 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. |
| --name | The storage volume name. If not provided, default name will be assigned |
| * --node-id | The node ID. Required unless "--node-name" is specified |
| * --node-name | The node name. Required unless "--node-id" is specified |
| --path | The path within the share |
| --share-id | The ID of the share into which data is assimilated |
| --share-name | The name of the share into which data is assimilated |
| --smb-default-group |
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. |
| --smb-default-user |
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. |
| --smb-password | Password for SMB username used to assimilate SMB data |
| --smb-path | 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 |
| --smb-share | 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 | 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. |
| --source-path | 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 |
| --update-assimilation | Indicates that this assimilation is an update of a previous one (a re-assimilation), and as such, the destination directory is allowed to be non-empty. Warning: this option will overwrite files that have changed and it will delete files and directories in the destination that no longer exists at the source |
| --utilization-threshold | The storage volume utilization threshold |
volume-assimilation
Usage: volume-assimilation [options]
Assimilate an existing storage volume
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --destination-path | The path within the share to into which data is assimilated |
| --help | Display this help and exit |
| * --id | The volume ID. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the volume. Required unless "--id" or "--name" is specified |
| --log | Causes assimilation to log data into <share/mount/path>/assimilation-logs-<date>/ |
| * --name | The volume name. Required unless "--id" or "--internal-id" is specified |
| --path | The path within the share into which data is assimilated |
| * --share-id | The ID of the share into which data is assimilated. Required unless "--share-name" is specified |
| * --share-name | The name of the share into which data is assimilated. Required unless "--share-id" is specified |
| --smb-default-group | 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. |
| --smb-default-user | 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. |
| --smb-password | Password for SMB username used to assimilate SMB data |
| --smb-path | 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 |
| --smb-share | 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 | 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. |
| --source-path | 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 |
| --update | Indicates that this assimilation is an update of a previous one (a re-assimilation), and as such, the destination directory is allowed to be non-empty. Warning: this option will overwrite files that have changed and it will delete files and directories in the destination that no longer exists at the source |
volume-assimilation-cancel
Usage: volume-assimilation-cancel [options]
Cancel a running assimilation
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--task-id | The task ID associated with the running assimilation |
volume-decommission
Usage: volume-decommission [options]
Start the storage volume decommission process
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | Storage Volume identifier. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | Storage Volume internal identifier. Required unless "--id" or "--name" is specified |
| * --name | Storage Volume name. Required unless "--id" or "--internal-id" is specified |
| --replace-with | List of locations to replace the decommissioned volume. Example: node:<name>,volume-group:<name>,volume:<name>,object-volume:<name> |
volume-decommission-cancel
Usage: volume-decommission-cancel [options]
Cancel the storage volume decommission process
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | Storage Volume identifier. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | Storage Volume internal identifier. Required unless "--id" or "--name" is specified |
| * --name | Storage Volume name. Required unless "--id" or "--internal-id" is specified |
volume-fail
Usage: volume-fail [options]
Fail the storage volume
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | The ID of the storage volume to fail. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the storage volume to fail. Required unless "--id" or "--name" is specified |
| * --name | The name of the storage volume to fail. Required unless "--id" or "--internal-id" is specified |
volume-group-create
Usage: volume-group-create [options]
Create a new volume group
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --description | The volume group's description |
| * --expression | The volume group expression(s). Expressions are separated by '&' |
| * --name | The volume group name |
volume-group-delete
Usage: volume-group-delete [options]
Delete a volume group
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | The ID of the volume group to delete. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the volume group to delete. Required unless "--id" or "--name" is specified |
| * --name | The name of the volume group to delete. Required unless "--id" or "--internal-id" is specified |
volume-group-list
Usage: volume-group-list [options]
Display a detailed list of all volume groups available in the system
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | The ID of the volume group to list |
| --internal-id | The internal ID of the volume group to list |
| --name | The name of the volume group to list |
volume-group-update
Usage: volume-group-update [options]
Update a volume group
| Options | Descriptions |
|---|---|
| --description | The volume group's description. Required unless "--expressions" or "--expressions-clear" or "--new-name" or "--description-clear " is specified |
| --description-clear | "". Required unless "--expressions" or "--expressions-clear" or "--description" or "--new-name" is specified |
| --expressions | The volume group expression(s). Expressions are separated by '&'. Required unless "--expressions-clear" or "--description" or "--new-name" or "--description-clear" is specified |
| --expressions-clear | "". Required unless "--expressions" or "--description" or "--new-name" or "--description-clear" is specified |
| --help | Display this help and exit |
| * --id | The ID of the volume group to update. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the volume group to update. Required unless "--id" or "--name" is specified |
| * --name | The name of the volume group to update. Required unless "--id" or "--internal-id" is specified |
| --new-name | The volume group updated name. |
volume-list
Usage: volume-list [options]
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)
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | The ID of the storage volume to list |
| --internal-id | The internal ID of the volume to list |
| --name | The name of the storage volume to list |
volume-remove
Usage: volume-remove [options]
Remove a storage volume from the system. The storage volume must be in the DECOMMISSIONED or FAILED state
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | The ID of the storage volume to remove. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the storage volume to remove. Required unless "--id" or "--name" is specified |
| *--name | The name of the storage volume to remove. Required unless "--id" or "--internal-id" is specified |
volume-set-available
Usage: volume-set-available [options]
Mark an unavailable storage volume as available
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | The ID of the storage volume to mark available. Required unless "--internal-id" or "--name" is specified |
| *--internal-id | The internal ID of the storage volume to mark available. Required unless "--name" or "--id" is specified |
| *--name | The name of the storage volume to mark available. Required unless "--internal-id" or "--id" is specified |
volume-set-unavailable
Usage: volume-set-unavailable [options]
Mark a storage volume as unavailable
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | The ID of the storage volume to mark unavailable. Required unless "--internal-id" or "--name" is specified |
| *--internal-id | The internal ID of the storage volume to mark unavailable. Required unless "--name" or "--id" is specified |
| *--name | The name of the storage volume to mark unavailable. Required unless "--internal-id" or "--id" is specified |
volume-update
Usage: volume-update [options]
Update storage volume attributes, including the volume performance and availability attributes
| Options | Descriptions |
|---|---|
| --add-excluded-ip | 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 |
| --availability | The storage volume availability capability, specified as the number of nines (number between 1 and 11) |
| --clear-excluded-ip | Remove all values from the list of excluded IP addresses |
| --disable-encryption | Disallow data from being encrypted when stored on the volume |
| --disable-offloaded-cloning | Disallow offloaded cloning from being performed on the volume, whether supported or not |
| --durability | The storage volume durability capability, specified as the number of nines (number between 1 and 11) |
| --enable-encryption | Allow data to be encrypted when stored on the volume |
| --enable-offloaded-cloning | Allow offloaded cloning to be performed on the volume when supported |
| --help | Display this help and exit |
| * --id | The ID of the storage volume to update. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the storage volume to update. Required unless "--id" or "--name" is specified |
| --max-suspected-time | 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. |
| * --name | The name of the storage volume to update. Required unless "--id" or "--internal-id" is specified |
| --new-name | The storage volume new name |
| --read-bandwidth | The storage volume read bandwidth (in kb/sec) |
| --read-iops | The storage volume read number of IOPs |
| --read-latency | The storage volume read latency (in microsecs) |
| --remove-excluded-ip | 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 |
| --tolerable-read-latency | The storage volume tolerable read latency (in nanoseconds) |
| --tolerable-write-latency | The storage volume tolerable write latency (in nanoseconds) |
| --utilization-threshold | The storage volume utilization threshold |
| --write-bandwidth | The storage volume write bandwidth (in kb/sec) |
| --write-iops | The storage volume write number of IOPs |
| --write-latency | The storage volume write latency (in microsecs) |