Read
GET v1/volumes
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| id | NsObjectID |
| name | NsVolSnapName |
| full_name | NsVolSnapName |
| search_name | NsSearchName |
| size | NsUnsignedLong |
| description | NsDescription |
| perfpolicy_name | NsObjectName |
| perfpolicy_id | NsObjectID |
| reserve | NsPercent |
| warn_level | NsPercent |
| limit | NsPercent |
| snap_reserve | NsUnsignedLong |
| snap_warn_level | NsUnsignedLong |
| snap_limit | NsUnsignedLong |
| num_snaps | NsUnsignedLong |
| projected_num_snaps | NsUnsignedLong |
| online | NsBoolean |
| owned_by_group | NsObjectName |
| owned_by_group_id | NsObjectID |
| multi_initiator | NsBoolean |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| read_only | NsBoolean |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| block_size | NsBytes |
| offline_reason | NsOfflineReason |
| clone | NsBoolean |
| parent_vol_name | NsVolSnapName |
| parent_vol_id | NsObjectID |
| base_snap_name | NsVolSnapName |
| base_snap_id | NsObjectID |
| volcoll_name | NsObjectName |
| volcoll_id | NsOptionalObjectID |
| agent_type | NsAgentType |
| force | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
| dest_pool_name | NsObjectName |
| dest_pool_id | NsObjectID |
| move_start_time | NsTime |
| move_aborting | NsBoolean |
| move_bytes_migrated | NsBytes |
| move_bytes_remaining | NsBytes |
| move_est_compl_time | NsTime |
| usage_valid | NsBoolean |
| vol_usage_compressed_bytes | NsBytes |
| vol_usage_uncompressed_bytes | NsBytes |
| snap_usage_compressed_bytes | NsBytes |
| snap_usage_uncompressed_bytes | NsBytes |
| snap_usage_populated_bytes | NsBytes |
| cache_pinned | NsBoolean |
| pinned_cache_size | NsBytes |
| cache_needed_for_pin | NsBytes |
| upstream_cache_pinned | NsBoolean |
| cache_policy | NsCachePolicy |
| thinly_provisioned | NsBoolean |
| vol_state | NsVolStatus |
| num_connections | NsUnsignedLong |
| num_iscsi_connections | NsUnsignedLong |
| num_fc_connections | NsUnsignedLong |
| encryption_cipher | NsEncryptionCipher |
| app_uuid | NsAppUuid |
| folder_id | NsOptionalObjectID |
| folder_name | NsObjectName |
| caching_enabled | NsBoolean |
| previously_deduped | NsBoolean |
| dedupe_enabled | NsBoolean |
| vpd_t10 | NsString |
| vpd_ieee0 | NsString |
| vpd_ieee1 | NsString |
| app_category | NsString |
GET v1/volumes/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| fields | NsCommaSeparatedList |
| id | NsObjectID |
| name | NsVolSnapName |
| full_name | NsVolSnapName |
| search_name | NsSearchName |
| size | NsUnsignedLong |
| description | NsDescription |
| perfpolicy_name | NsObjectName |
| perfpolicy_id | NsObjectID |
| reserve | NsPercent |
| warn_level | NsPercent |
| limit | NsPercent |
| snap_reserve | NsUnsignedLong |
| snap_warn_level | NsUnsignedLong |
| snap_limit | NsUnsignedLong |
| num_snaps | NsUnsignedLong |
| projected_num_snaps | NsUnsignedLong |
| online | NsBoolean |
| owned_by_group | NsObjectName |
| owned_by_group_id | NsObjectID |
| multi_initiator | NsBoolean |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| read_only | NsBoolean |
| serial_number | NsISCSISerialNumber |
| target_name | NsTargetName |
| block_size | NsBytes |
| offline_reason | NsOfflineReason |
| clone | NsBoolean |
| parent_vol_name | NsVolSnapName |
| parent_vol_id | NsObjectID |
| base_snap_name | NsVolSnapName |
| base_snap_id | NsObjectID |
| volcoll_name | NsObjectName |
| volcoll_id | NsOptionalObjectID |
| agent_type | NsAgentType |
| force | NsBoolean |
| creation_time | NsTime |
| last_modified | NsTime |
| dest_pool_name | NsObjectName |
| dest_pool_id | NsObjectID |
| move_start_time | NsTime |
| move_aborting | NsBoolean |
| move_bytes_migrated | NsBytes |
| move_bytes_remaining | NsBytes |
| move_est_compl_time | NsTime |
| usage_valid | NsBoolean |
| vol_usage_compressed_bytes | NsBytes |
| vol_usage_uncompressed_bytes | NsBytes |
| snap_usage_compressed_bytes | NsBytes |
| snap_usage_uncompressed_bytes | NsBytes |
| snap_usage_populated_bytes | NsBytes |
| cache_pinned | NsBoolean |
| pinned_cache_size | NsBytes |
| cache_needed_for_pin | NsBytes |
| upstream_cache_pinned | NsBoolean |
| cache_policy | NsCachePolicy |
| thinly_provisioned | NsBoolean |
| vol_state | NsVolStatus |
| num_connections | NsUnsignedLong |
| num_iscsi_connections | NsUnsignedLong |
| num_fc_connections | NsUnsignedLong |
| encryption_cipher | NsEncryptionCipher |
| app_uuid | NsAppUuid |
| folder_id | NsOptionalObjectID |
| folder_name | NsObjectName |
| caching_enabled | NsBoolean |
| previously_deduped | NsBoolean |
| dedupe_enabled | NsBoolean |
| vpd_t10 | NsString |
| vpd_ieee0 | NsString |
| vpd_ieee1 | NsString |
| app_category | NsString |
Description
Retrieve information on a set of volumes or a single volume.
Normal Response Codes
200
HTTP Error Codes
400 401 404 500 503
Detail Error Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsVolSnapName | string | Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| full_name | NsVolSnapName | string | Fully qualified name of volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| search_name | NsSearchName | string | Name of volume used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| size | NsUnsignedLong | number | Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume. Unsigned 64-bit integer. Example: 1234. | |
| description | NsDescription | string | Text description of volume. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| perfpolicy_name | NsObjectName | string | Name of performance policy. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| perfpolicy_id | NsObjectID | string | Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| reserve | NsPercent | number | Amount of space to reserve for this volume as a percentage of volume size. Percentage as integer from 0 to 100. | |
| warn_level | NsPercent | number | Threshold for available space as a percentage of volume size below which an alert is raised. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume. Percentage as integer from 0 to 100. | |
| limit | NsPercent | number | Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100. | |
| snap_reserve | NsUnsignedLong | number | Amount of space to reserve for snapshots of this volume as a percentage of volume size. Unsigned 64-bit integer. Example: 1234. | |
| snap_warn_level | NsUnsignedLong | number | Threshold for available space as a percentage of volume size below which an alert is raised. Unsigned 64-bit integer. Example: 1234. | |
| snap_limit | NsUnsignedLong | number | Limit for snapshots of the volume as a percentage of volume size. If this option is not specified, default snapshot limit set on the group is used to specify no limit for snapshot data. Unsigned 64-bit integer. Example: 1234. | |
| num_snaps | NsUnsignedLong | number | Number of live, non-hidden snapshots for this volume. Unsigned 64-bit integer. Example: 1234. | |
| projected_num_snaps | NsUnsignedLong | number | Projected number of snapshots (including schedued and manual) for this volume. Unsigned 64-bit integer. Example: 1234. | |
| online | NsBoolean | boolean | Online state of volume, available for host initiators to establish connections. Possible values: 'true', 'false'. | |
| owned_by_group | NsObjectName | string | Name of group that currently owns the volume. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| owned_by_group_id | NsObjectID | string | ID of group that currently owns the volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| multi_initiator | NsBoolean | boolean | This indicates whether volume and its snapshots are multi-initiator accessible. This attribute applies only to volumes and snapshots available to iSCSI initiators. Possible values: 'true', 'false'. | |
| pool_name | NsObjectName | string | Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| pool_id | NsObjectID | string | Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| read_only | NsBoolean | boolean | Volume is read-only. Possible values: 'true', 'false'. | |
| serial_number | NsISCSISerialNumber | string | Identifier associated with the volume for the SCSI protocol. A 32 digit hexadecimal number. Example: '1234123412341234abcdacbdacbdacbd'. | |
| target_name | NsTargetName | string | The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target. | |
| block_size | NsBytes | number | Size in bytes of blocks in the volume. Unsigned 64-bit integer. Example: '1234'. | |
| offline_reason | NsOfflineReason | string enum | Volume offline reason. Possible values: 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'over_snapshot_reserve', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress'. | |
| clone | NsBoolean | boolean | Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true. Possible values: 'true', 'false'. | |
| parent_vol_name | NsVolSnapName | string | Name of parent volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| parent_vol_id | NsObjectID | string | Parent volume ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| base_snap_name | NsVolSnapName | string | Name of base snapshot. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. | |
| base_snap_id | NsObjectID | string | Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| volcoll_name | NsObjectName | string | Name of volume collection of which this volume is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| volcoll_id | NsOptionalObjectID | string | ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example: '1234123412341234123412341234123412341234cd' or ''. | |
| agent_type | NsAgentType | string enum | External management agent type. Possible values: 'none', 'smis', 'all', 'vvol', 'openstack'. | |
| force | NsBoolean | boolean | Forcibly offline, reduce size or change read-only status a volume. Possible values: 'true', 'false'. | |
| creation_time | NsTime | number | Time when this volume was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this volume was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| dest_pool_name | NsObjectName | string | Name of the destination pool where the volume is moving to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| dest_pool_id | NsObjectID | string | ID of the destination pool where the volume is moving to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| move_start_time | NsTime | number | The Start time when this volume was moved. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| move_aborting | NsBoolean | boolean | This indicates whether the move of the volume is aborting or not. Possible values: 'true', 'false'. | |
| move_bytes_migrated | NsBytes | number | The bytes of volume which have been moved. Unsigned 64-bit integer. Example: '1234'. | |
| move_bytes_remaining | NsBytes | number | The bytes of volume which have not been moved. Unsigned 64-bit integer. Example: '1234'. | |
| move_est_compl_time | NsTime | number | The estimated time of completion of a move. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| usage_valid | NsBoolean | boolean | This indicates whether usage information of volume and snapshots are valid or not. Possible values: 'true', 'false'. | |
| vol_usage_compressed_bytes | NsBytes | number | Compressed data in bytes for this volume. Unsigned 64-bit integer. Example: '1234'. | |
| vol_usage_uncompressed_bytes | NsBytes | number | Uncompressed data in bytes for this volume. Unsigned 64-bit integer. Example: '1234'. | |
| snap_usage_compressed_bytes | NsBytes | number | Sum of compressed backup data in bytes stored in snapshots of this volume. Unsigned 64-bit integer. Example: '1234'. | |
| snap_usage_uncompressed_bytes | NsBytes | number | Sum of uncompressed unique backup data in bytes stored in snapshots of this volume. Unsigned 64-bit integer. Example: '1234'. | |
| snap_usage_populated_bytes | NsBytes | number | Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots. Unsigned 64-bit integer. Example: '1234'. | |
| cache_pinned | NsBoolean | boolean | If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume. Possible values: 'true', 'false'. | |
| pinned_cache_size | NsBytes | number | The amount of flash pinned on the volume. Unsigned 64-bit integer. Example: '1234'. | |
| cache_needed_for_pin | NsBytes | number | The amount of flash needed to pin the volume. Unsigned 64-bit integer. Example: '1234'. | |
| upstream_cache_pinned | NsBoolean | boolean | This indicates whether the upstream volume is cache pinned or not. Possible values: 'true', 'false'. | |
| cache_policy | NsCachePolicy | string enum | Cache policy applied to the volume. Possible values: 'disabled', 'normal', 'aggressive', 'no_write', 'aggressive_read_no_write'. | |
| thinly_provisioned | NsBoolean | boolean | Allow volume to be advertised as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. This change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently. Possible values: 'true', 'false'. | |
| vol_state | NsVolStatus | string enum | Status of the volume. Possible values: 'online', 'offline', 'non_writable', 'read_only', 'login_only'. | |
| online_snaps | NsSnapshotListFromVolumes | Array of NsSnapshotFromVolumes | The list of online snapshots of this volume. Snapshot list as presented in volumes object set. | |
| num_connections | NsUnsignedLong | number | Number of connections of this volume. Unsigned 64-bit integer. Example: 1234. | |
| num_iscsi_connections | NsUnsignedLong | number | Number of iscsi connections of this volume. Unsigned 64-bit integer. Example: 1234. | |
| num_fc_connections | NsUnsignedLong | number | Number of Fibre Channel connections of this volume. Unsigned 64-bit integer. Example: 1234. | |
| access_control_records | NsAccessControlRecords | Array of NsAccessControlRecord | List of access control records that apply to this volume. List of access control records associated with a volume or snapshot or protocol endpoint. | |
| encryption_cipher | NsEncryptionCipher | string enum | The encryption cipher of the volume. Possible values: 'none', 'aes_256_xts'. | |
| app_uuid | NsAppUuid | string | Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'. | |
| folder_id | NsOptionalObjectID | string | ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example: '1234123412341234123412341234123412341234cd' or ''. | |
| folder_name | NsObjectName | string | Name of the folder holding this volume. It can be empty. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| metadata | NsKeyValues | Array of NsKeyValue | Key-value pairs that augment a volume's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. | |
| iscsi_sessions | NsISCSISessions | Array of NsISCSISession | List of iSCSI sessions connected to this volume. List of iSCSI initiator sessions information. | |
| fc_sessions | NsFCSessions | Array of NsFCSession | List of Fibre Channel sessions connected to this volume. List of Fibre Channel initiator sessions information. | |
| caching_enabled | NsBoolean | boolean | Indicate caching the volume is enabled. Possible values: 'true', 'false'. | |
| previously_deduped | NsBoolean | boolean | Indicate whether dedupe has ever been enabled on this volume. Possible values: 'true', 'false'. | |
| dedupe_enabled | NsBoolean | boolean | Indicate whether dedupe is enabled. Possible values: 'true', 'false'. | |
| vpd_t10 | NsString | string | The volume's T10 Vendor ID-based identifier. Plain string. | |
| vpd_ieee0 | NsString | string | The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string. | |
| vpd_ieee1 | NsString | string | The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string. | |
| app_category | NsString | string | Application category that the volume belongs to. Plain string. |
JSON Response