VEveritas
Volumes

Get volume info

Get details about a particular volume.

get/diskgroups/{DgId}/volumes/{VolId}

Request

Path parameters

DgIdstring required

Diskgroup identifier

VolIdstring required

Name of the volume.

Query parameters

nodenamestring

If specified, volume details will be listed from the specified node. Else, a node where volume is created will be chosen internally. Error will be returned for a nodename specified which does not has the particular volume created.

humanReadableFormatboolean

Specify true to display attributes related to volume size in human readable format

Response

Volume details

Namestring

User provided name of the volume

Sizestring

Size of the volume

DiskgroupIdstring

Unique diskgroup identifier

DiskgroupNamestring

Name of diskgroup or pool

Statestring

State of volume (use "start" keyword to start the volume and "stop" keyword to stop the volume in case of PATCH)

Layoutstring

Layout of volume Eg mirror, concat

KernelStatestring

Kernel state of volume(Enable/Disable)

RvgIdstring uri

Replicated Volume Group link of volume

VsetIdstring uri

Volume set link

Logtypestring

Type of log associated like dco, dcm, old style drl etc.

Nloginteger

Specifies the number of log plexes

Loglenstring

Specifies size of log

Nstripeinteger

Number of stripes/columns

Stripeunitstring

Stripe unit size

Nmirrorinteger

Number of mirrors for mirrored layout

Mirrorstring

Specifies that volumes should be mirrored across instances of a particular disk class like array (enclr), ctlr, host, site etc

Stripestring

Specifies that volumes should be striped across instances of a particular disk class like array (enclr), ctlr, host, site etc

MirrorConfinestring

Specifies a required list of disk classes for confining a mirror.

NSnapMirrorinteger

Specifies mirrors to a volume for use in creating third-mirror break-off snapshots.

NSnapMirrorsInSyncinteger

Specifies mirrors to a volume that are in sync for use in creating third-mirror break-off snapshots.

StorageSpecificationstring

Storage specification to select certain types of disks for the allocation during mirror creation like ctlr:c1 or mediatype:ssd etc.

Flagsstring

Flags like encrypted, vxcloud, fscloud etc. set on the volume

ExtendableSizestring

Maximum size a volume can be extended to

Modestring

Mode/Permissions set on the volume

Userstring

User that owns a volume record to the user specified as the attribute value. The attribute value can be either a login name from the /etc/passwd database, or a numeric user ID

Groupstring

Group that owns a volume record to the group specified as the attribute value. The attribute value can be either a group name from the group database, or a numeric group ID

Mountedboolean

Display whether volume is mounted or not

IsSnapshotboolean

Display whether volume is snapshot or not

Changes

No recorded changes to this operation across all 1 revision of this API.