Follow

Volume provisioning commands

Volume commands allow you to create volumes. You can use the volume commands to map each volume to a host or a cluster, to rename and resize the volume, to restore it from a snapshot, to protect it from writing, to enable SSD cache, to set it to be thin provisioned, to move it between pools and to query the InfiniBox volumes. This category does not include commands for provisioning snapshots.


config.system.set_auto_udid_range

ROLE: Admin

DescriptionEnables / disables default pool ssd cache.
Syntax

config.system.set_auto_udid_range [start=CONFIGUDID] [end=CONFIGUDID] [disabled=YESNO]

ArgumentsstartAn integer number between 1 and 32767 (inclusive)
disabledEither yes or no
endAn integer number between 1 and 32767 (inclusive)

vol.assign_qos 

ROLE: Admin

DescriptionAssign volume to policy
Syntaxvol.assign_qos vol=vol[,vol...] policy=QOSVOLUMESPOLICY
ArgumentspolicyQoS policy
poolName of an existing pool (multiple values, separated by commas)
Examplevol.assign_qos pool=v2 policy=q1
Volume 'v2' was assigned to policy 'q1'

vol.cache 

ROLE: Admin, Pool Admin

Description

Enable or disable SSD cache.

Set the optional parameter Recursive to Yes in order to apply the SSD cache settings to the entire volume tree.

Syntaxvol.cache vol=VOL ssd_cache=YESNO [recursive=YESNO]
ArgumentsrecursiveEither yes or no
ssd_cacheEither yes or no
volName of an existing volume
Examplevol.cache name=vol1 ssd=yes recursive=yes
Volume vol1 and all descendants SSD cache enabled.

vol.create  

ROLE: Admin, Pool Admin

Description

Create a new volume.

Create a batch of volumes by stating the requested amount of volumes using the Series parameter. The volumes names are prefixed. It is recommended to denote a new prefix for each batch. The pool parameter is not required in case there is only one pool available. The volume size can be any number that is divisible by 512 (bytes). On the pool view, the volume size is represented in a number that is divisible by 64k.

Syntaxvol.create name=NAME[,NAME,...] size=SIZE [pool=STANDARDPOOL] [thin=YES|NO|Y|N] [ssd_cache=YES|NO|Y|N] [compression=YES|NO|Y|N] [series=SERIES] [udid=UDID]
ArgumentspoolName of an existing standard pool
sizeA positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000
nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. (multiple values, separated by commas)
thinEither yes, or no
ssd_cacheEither yes, or no
udidAUTO, or an integer number between 1 and 32767 (inclusive)
compressionEither yes, or no
seriesEither a range of numbers, e.g "3-7", or a single number, e.g "5", which is the same as "1-5". Zero-padding the numbers yields a zero-padded sequence. The series may contain at most 100 items, and the index of the last item may not exceed 10000000000
Example

Creating a single volume, providing a name and specifying the volume size and the pool it will created in.
vol.create name=vol1 size=1g pool=pool1
Volume vol1 created
ExampleCreating a series of volumes specifying their number. The volumes will be numbered from 1 onward.
Note that the name parameter serves as a prefix to the entire series.
vol.create name=vol- size=1g pool=pool1 series=10
Created 10 volumes: vol-01 through vol-10
ExampleCreating a series of volumes specifying the first and last ordinal numbers.
vol.create name=vol- size=1g pool=pool1 series=11-20
Created 10 volumes: vol-11 through vol-20

vol.delete

ROLE: Admin, Pool Admin

Description

Delete volume.

You may select multiple volumes, separated with a comma.

Syntaxvol.delete vol=VOL[,VOL,...]
ArgumentsvolName of an exiting volume ( multiple values, separated by commas)
Examplevol.delete name=vol1

Volume vol1 deleted


vol.map

ROLE: Admin, Pool Admin

Description

Map volume to host or cluster.

You may determine the LUN that will connect the volume to the host, or cluster.

Syntaxvol.map vol=VOL[,VOL,...] [host=HOST] [cluster=CLUSTER] [lun=LUN]
ArgumentsvolName of an existing volume (multiple values, separated by commas)
lunSCSI logical unit number (LUN)
clusterName of an existing cluster
hostName of an existing host
Examplevol.map name=vol1 cluster=cluster1
volume vol1 mapped to LUN 12 in cluster cluster1

vol.map_query

ROLE: All Roles

Description

List host and cluster mappings by volume.

Syntax

vol.map_query [vol=VOL[,VOL,...]] [pool=STANDARDPOOL] [host=HOST] [cluster=CLUSTER]

ArgumentsvolName of an existing volume (multiple values, separated by commas)
poolName of an existing standard pool
clusterName of an existing cluster
hostName of an existing host
Examplevol.map_query

NAME  MAPPING TYPE  MAPPED TO  LUN ID
vol1  CLUSTER       cluster1   l1
vol2  CLUSTER       cluster1   l2



vol.move 

ROLE: Admin, Pool Admin 

Description

Move volume to a different pool. 

The move_capacity parameter determines whether the volume moves along with its capacity, so as not to
impact the new pool free space. The default value of this parameter is no.

Syntaxvol.move vol=VOL pool=STANDARDPOOL [move_capacity=YES|NO|Y|N]
ArgumentspoolName of an existing standard pool 
volName of an existing volume
move_capacity         Either yes or no
ExampleMoving a volume with its capacity
vol.move name=vol1 pool=pool2 move_capacity=yes
Volume vol1 moved to pool pool2 with its capacity
ExampleMoving a volume without its capacity
vol.move name=vol1 pool=pool2
Volume vol1 and all descendants SSD cache enabled.

vol.query 

ROLE: All Rolls

Description

List existing volumes.

  • Use the unit argument to specify the units of the capacity fields of the output.
  • To view all of the available volume attributes, run:
    • vol.query --columns= and then press TAB. See an example below.
Syntaxvol.query [vol=VOL[,VOL,...]] [cg=CG] [pool=STANDARDPOOL] [unit=CAPACITYUNIT] [mapped=YESNO] [write_protected=YESNO] [thin=YESNO] [compression_enabled=YESNO] [ssd_enabled=YESNO]
ArgumentscgName of an existing consistency group 
volName of an existing volume
compression_enabledEither yes or no
thinEither yes or no
write_protectedEither yes or no
mappedEither yes or no
unitB, G (or GB), GiB, T (or TB), TiB or block
ssd_enabledEither yes or no
poolname of an exiting standard pool
Example

Querying for all volumes
vol.query 

NAME THIN  SIZE      USED   ALLOCATED COMPRESSION SNAPSHOTS POOL WP MAPPED
                                      SAVINGS
v1   no    1.00 TB   100 GB 1.00 TB   1.00:1      0         p1   no  yes

Example

Querying for volumes that belong to a consistency group, returning the ID of the consistency group
vol.query --columns=name,cg_id

NAME  CG ID
v1    1272
v2    1272
v3    --

ExampleQuerying for compressed volumes, and displaying only compression-related columns
vol.query compression_enabled=yes --columns=name,compressed,data_reduction

NAME  COMPRESSED  DATA REDUCTION
v1    yes         9.34:1
v2    yes         1.64:1
v3    yes         1.64:1

ExampleQuerying for volumes that are assigned to a QoS policy
vol.query --columns=name,policy

NAME  POLICY
v1    q1
v2    --

ExampleGet all of the available volume's attributes
vol.query --columns=
name, serial, thin, size, used, allocated, Snapshots, cg, policy, wp, pool, compressed, data_reduction, mapped, ssd_cache, replication_role, created_at, updated_at, cg_id or * (multiple values, separated by commas) * cg created_at name replication_role ssd_cache used Snapshots cg_id data_reduction policy serial thin wp allocated compressed mapped pool size updated_at
ExampleQuery for the volume's serial number
vol.query name=v1 --columns=name,serial

NAME  SERIAL
v1    742b0f000004e21000000000182e663



vol.reclaimable 

ROLE:  Admin, Pool Admin

Description

Estimate reclaimed capacity (deletion simulation).

You may simulate the deletion of the filesystem and its descendants.

Syntaxvol.reclaimable vol={VOL|SNAP}
ArgumentsvolName of an existing volume or snapshot
Examplevol.reclaimable name=vol1
Estimated reclaimable space for volume v1 and its tree descendants: 327.68 KB

vol.rename

ROLE: Admin, Pool Admin

Description

Rename volume 

Syntaxvol.rename vol=VOL new_name=NAME
Argumentsnew_nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks).
Leading and trailing whitespace characters are stripped
volName of an existing volume 
Examplevol.rename name=vol1 new_name=vol2
Volume volume1 renamed to volume2



vol.reset_serial

ROLE: Admin

Description

Reset volume serial 

Syntaxvol.reset_serial vol=VOL
ArgumentsvolName of an exiting volume  

ADMIN


vol.resize

ROLE: Admin

DescriptionResize volumes
Syntaxvol.resize vol=VOL size=SIZEPOSITIVEDELTA
ArgumentsvolName of an existing volume
sizeA number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000. When preceded by a plus sign, represents a delta; e.g. 3000000m (absolute size), +2000GB (positive delta)
Examplevol.resize name=vol1 size=1.5t
Volume vol1 updated



vol.restore 

ROLE: Admin, Pool Admin

Description

Restore data state of a volume from one of its snapshots.

This command restores a volume from one of its snapshots.

  • The volume can be restored from any of its snapshots
Syntaxvol.restore vol=VOL source=SNAP
ArgumentsvolName of an existing volume
sourceName of an exiting volume snapshot 
Examplevol.restore name=vol1 snap=snap1
Volume vol1 restored from snapshot snap1



vol.set_compression

ROLE: Admin, Pool Admin

Description

Set a volume to use compression 

Syntaxvol.set_compression vol=VOL compression=YESNO
ArgumentscompressionEither yes or no
volName of an exiting volume 
ExampleEnable compression on a volume
vol.set_compression name=v1 enable=yes
Volume "v1" Compression was enabled
ExampleDisable compression on a volume
vol.set_compression name=v1 enable=no
Volume "v1" Compression was disabled



vol.set_thin

ROLE: Admin, Pool Admin

Description

Set volume provisioning type

Toggle between thin and thick provisioning. 

Syntaxvol.set_thin vol=VOL thin=YESNO
ArgumentsthinEither yes or no
volName of an exiting volume 
Examplevol.set_thin name=vol1 thin=yes
Volume vol1 set to thin provisioning



vol.set_udid 

ROLE: Admin, Pool Admin

Description

Change UDID on a volume. 

Syntaxvol.set_udid vol=VOL udid=UDIDUPDATE
ArgumentsvolName of an existing volume
udidCLEAR, or an integer number between 1 and 32767 (inclusive)

vol.tree 

ROLE: All Roles

Description

Display hierarchy of volumes and their snapshots.

You may filter the results by volume and pool.

Syntaxvol.tree [vol=VOL] [pool=POOL] [unit=CAPACITYUNIT]
ArgumentsunitB, G (or GB), GiB, T (or TB), TiB or block
poolName of an existing pool
volName of an existing volume
Examplevol.tree name=v1

NAME     TYPE  SIZE    USED    ALLOCATED  POOL  WP  CREATED AT 
v1       VOL   1.00 TB 100 GB  1.0 TB     p1    no  2015*12-01 10:00:00
|-----s1 SNAP  0       0       0          p1    yes 2015-12-02 10:00:00



vol.unassign_qos 

ROLE: Admin

Description

Unassign volume from policy.

  • Unassigning the volume does not unassign its snapshots, even if both volume and snapshot are assigned to the same policy.
  • This command allows for a multiple-entity selection
Syntaxvol.unassign_qos vol=VOL[,VOL,...]

volName of an existing volume (multiple values, separated by commas)
ExampleUnassigning a single volume
vol.unassign_qos vol=v2
Volume 'v2' was unassigned from policy 'q1'
ExampleUnassigning several volumes
vol.unassign_qos vol=v1,v2
2 volumes were unassigned from their policies



vol.unmap

ROLE: Admin, Pool Admin

Description

Unmap volume from host or cluster

Syntaxvol.unmap vol=VOL[,VOL,...] [host=HOST] [cluster=CLUSTER]
ArgumentsclusterName of an existing cluster
hostName of an existing host
volName of an existing volume (multiple values, separated by commas)
Examplevol.unmap name=vol1 cluster=cluster1
Volume vol1 unmapped from LUN LUN1 in cluster cluster1



vol.write_enable

ROLE: Admin, Pool Admin

Description

Enable write access on volume.

Set the optional parameter Recursive to Yes in order to enable writing to the entire volume tree. 

Syntaxvol.write_enable vol=VOL [recursive=YESNO]
ArgumentsrecursiveEither yes or no
volName of an existing volume 
Examplevol.write_enable name=vol1 recursive=yes
Volume vol1 and all descendants write access enabled



vol.write_protect

ROLE: Admin, Pool Admin

Description

Disable access on volume.

Set the optional parameter Recursive to Yes in order to disable writing to the entire volume tree. 

Syntaxvol.write_protect vol=VOL [recursive=YESNO]
ArgumentsrecursiveEither yes or no
volName of an existing volume 
Examplevol.write_protect name=vol1 recursive=yes
Volume vol1 and all descendants write access disabled


Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:31:39 UTC

Comments