virtualVolume
Suggest changes
PDFs
The virtualVolume object contains configuration information about a virtual volume as well as information about snapshots of the virtual volume. It does not include runtime or usage information. You can use the ListVirtualVolumes method to retrieve this information for a cluster.
Object members
This object contains the following members:
| Name | Description | Type |
|---|---|---|
bindings |
A list of binding IDs for this virtual volume. |
UUID array |
children |
A list of virtual volume UUIDs that are children of this virtual volume. |
UUID array |
descendants |
When you pass recursive: true to the ListVirtualVolumes method, contains a list of virtual volume UUIDs that are descendants of this virtual volume. |
UUID array |
metadata |
Key-value pairs of the virtual volume's metadata, such as virtual volume type, guest OS type, and so on. |
JSON object |
parentVirtualVolumeID |
The virtual volume ID of the parent virtual volume. If the ID is all zeros, this is an independent virtual volume with no link to a parent. |
UUID |
snapshotID |
The ID of the underlying volume snapshot. This value is "0" if the virtual volume does not represent a snapshot. |
integer |
snapshotInfo |
The snapshot object for the associated snapshot (null if nonixestent). |
|
status |
Current status of the virtual volume. Possible values:
|
string |
storageContainer |
An object describing the storage container that owns this virtual volume. |
|
virtualVolumeID |
The unique ID of the virtual volume. |
UUID |
virtualVolumeType |
The type of the virtual volume. |
string |
volumeID |
The ID of the underlying volume. |
integer |
volumeInfo |
When you pass details: true to the ListVirtualVolumes method, this member is an object describing the volume. |