Release notes
volume
Suggest changes
PDFs
The volume object contains configuration information about unpaired or paired volumes. It does not include runtime or usage information, and does not contain information about virtual volumes.
Object members
This object contains the following members:
| Name | Description | Type |
|---|---|---|
access |
The type of access allowed for the volume. Possible values:
|
string |
accountID |
The accountID of the account containing the volume. |
integer |
attributes |
List of name-value pairs in JSON object format. |
JSON object |
blockSize |
The size of blocks on the volume. |
integer |
createTime |
The UTC+0 formatted time the volume was created. |
ISO 8601 string |
currentProtectionScheme |
The protection scheme that is being used for this volume. If a volume is converting from one protection scheme to another, this member reflects the protection scheme to which the volume is converting. |
string |
deleteTime |
The UTC+0 formatted time the volume was deleted. |
ISO 8601 string |
enable512e |
If set to true, the volume provides 512 byte sector emulation. |
boolean |
enableSnapMirrorReplication |
Whether or not the volume can be used for replication with SnapMirror endpoints. |
boolean |
fifoSize |
Specifies the maximum number of snapshots of the volume to be maintained simultaneously if using the First-In-First-Out (FIFO) snapshot retention mode. |
integer |
iqn |
The iSCSI Qualified Name of the volume. |
string |
lastAccessTime |
The last time any access (including I/O) to the volume occurred (formatted as UTC+0). If the last access time is not known, this value is null. |
ISO 8601 string |
lastAccessTimeIO |
The last time any I/O to the volume occurred (formatted as UTC+0). If the last access time is not known, this value is null. |
ISO 8601 string |
minFifoSize |
Specifies the minimum number of First-In-First-Out (FIFO) snapshot slots reserved simultaneously by the volume if using the First-In-First-Out (FIFO) snapshot retention mode. |
integer |
name |
The name of the volume as provided at creation time. |
string |
previousProtectionScheme |
If a volume is converting from one protection scheme to another, this member reflects the protection scheme from which the volume is converting. This member does not change until a conversion is started. If a volume has never been converted, this member is null. |
string |
purgeTime |
The UTC+0 formatted time the volume was purged from the system. |
ISO 8601 string |
qos |
The quality of service settings for this volume. |
|
qosPolicyID |
The QoS policy ID associated with the volume. The value is null if the volume is not associated with a policy. |
integer |
scsiEUIDeviceID |
Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format. |
string |
scsiNAADeviceID |
Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format. |
string |
sliceCount |
The number of slices on the volume. This value is always "1". |
integer |
status |
The current status of the volume. Possible values:
|
string |
totalSize |
The total bytes of provisioned capacity. |
integer |
virtualVolumeID |
The unique virtual volume ID associated with the volume, if any. |
UUID |
volumeAccessGroups |
List of IDs pf volume access groups to which a volume belongs. This value is an empty list if a volume does not belong to any volume access groups. |
integer array |
volumeConsistencyGroupUUID |
The universally unique ID of the volume consistency group of which the volume is a member. |
UUID |
volumeID |
The unique volumeID for the volume. |
integer |
volumePairs |
Information about a paired volume. Visible only if a volume is paired. This value is an empty list if the volume is not paired. |
volumePair array |
volumeUUID |
The universally unique ID of the volume. |
UUID |