icmcli get volume

AI Tools

Gets an existing volume.

Synopsis

Gets an existing volume. Specify either --name or --uuid, but not both.

icmcli get volume [flags]

Examples

#get a volume in project: "proj" with volume name: "vol": icmcli get volume --project-name proj --name vol #get a volume in project: "proj" with volume uuid: "u-u-i-d": icmcli get volume --project-name proj --uuid u-u-i-d

Flag

Short

Type

Default

Description

--help

-h

bool


Help for volume.

--name


string


Volume name.

--project-name


string


The project this volume belongs to.

--uuid


string


Volume UUID.

Response Type

Returns a single Volume object with the following fields:

Field

Type

Description

state

StateEnum

Indicates the current state of the volume in its creation/update/delete lifetime. It will reflect the state of execution of a user-invoked API (CreateVolume, UpdateVolume), or an internal operation (Volume migration).

protectionState

ProtectionStateEnum

Indicates the volume's data availability derived from the health of each of the replicas it resides on.

replicaCount

integer

The number of replicas a volume can have. Valid values are 1, 2, and 3.

nodeList

array

List of node UUIDs this volume is placed over.

UUID

string


nsid

integer

Volume's Namespace ID.

acl

StringList

Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE.

compression

string

Valid values: true/enable/enabled or false/disable/disabled.

size

string


name

string

A volume's name is unique at the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9), hyphen (-), underscore (_), and period (.).

rebuildProgress

string

Progress of the volume's replica rebuild operation in percent.

statistics

VolumeStatisticsApi

Volume statistics. Contains information about the physical used capacity, used memory, compression ratio, and more.

IPAcl

StringList

Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE (optional, default: ALLOW_ANY).

ETag

string

Identifier for a specific version of a resource.

connectedHosts

array


sectorSize

integer

Volume sector size. Valid values: 4K (default), 512B.

projectName

string

Project name.

sourceSnapshotUUID

string

For a cloned volume, specify the source snapshot of this clone.

sourceSnapshotName

string

For a cloned volume, specify the source snapshot of this clone.

placementRestrictions

array


qosPolicyUUID

string

Optional volume's QoS policy UUID (if not specified the QoS policy defined in the volume's project is used).

qosPolicyName

string

Optional volume's QoS policy name (if not specified the QoS policy defined in the volume's project is used).

primaryNodeUUID

string

UUID of the primary node data is Read/Written for this volume.

creationTime

string

Time of volume creation (UTC).

labels

array

Optionally add labels to a volume.

clusterId

string

The ID of the cluster where the volume resides.