lbcli get volume
Gets information about a volume by name or UUID.
lbcli get volume --name=<name> [flags]lbcli get volume --uuid=<uuid> [flags]Examples:
# Get information of volume by UUID in project 'proj-1':lbcli -J $JWT get volume --project-name=proj-1 --uuid=32e7b7ab-4e6d-4b6c-8c4e-92710bcd9301# Get information of volume 'vol_1' in project 'a':lbcli -J $JWT get volume --name vol_1 --project-name a| Flag | Short | Type | Default | Description | Version |
|---|---|---|---|---|---|
| -name | string | Volume name. Either UUID or name must be specified, but not both. | |||
| --uuid | string | Volume UUID. Either UUID or name must be specified, but not both. | |||
| --help | -h | bool | Help for volume. | ||
| --project name | string | Project name. Project name is required when using the v2.0 API. | 2.1 and above |
This command returns the following fields for the volume. The default output format is yaml. The JSON output format is also supported. The human-readable output only shows some of these fields.
| Field | Type | Description |
|---|---|---|
| Name | String | Volume name. |
| UUID | String | Volume UUID. |
| State | String | The current volume state:
|
| Protection State | String | The current volume protection state:
Note: For any volumes that are in "Creating" or “Failed” state, the protection state is “Not available“. |
| NSID | Integer | Volume NSID. |
| Size | Integer | Maximal logical capacity of the volume in bytes. |
| Replica Count | Integer | Total replicas count. |
| Compression | boolean |
|
| ACL | List of strings | Access Control List. |
| Rebuild Progress | String | Rebuild progress in percentage. If a node that the volume is associated with is also undergoing the clustering rebuild process this field will show progress. Otherwise, it will show None. Note: This field displays information on the replications nodes state associated with this volume. So, it may show a rebuild even for volumes with no data. |
| Nodes List | List of strings | Node UUIDs on which the volume is stored (only in json/yaml). |
| IP ACL | List of string | List of allowed IPs (Default: ALLOW_ANY). |
| Connected Hosts | List of strings | List of host nqn connected to the volume. |
| Etag | String | An identifier for a specific version of a resource. |
| Source Snapshot Name | String | The source snapshot UUID which the volume was cloned from. An empty string means that this volume did not originate from a snapshot. |
| Source Snapshot UUID | String | The source snapshot name which the volume was cloned from. An empty string means that this volume did not originate from a snapshot. |
| QoS Policy UUID | String | The UUID of the QoS policy that is assigned to the volume. |
| QoS Policy Name | String | The name of the QoS policy that is assigned to the volume. |
Note: For examples and a full list of volume metrics, see lbcli list volumes.