Follow

The snapshot is an entity that allows the user to restore a volume to a specific point-in-time.

  • When the snapshot is created it is in read-only mode. It can become writable (by a specific user action).
  • A writable snapshot can restore its parent volume (or parent snapshot).
  • Snapshot operations create a snapshot, delete it, rename it, enable SSD cache, view its relation with the volume and other snapshots, map it to a host or a cluster, unmap it, query the mapping and query all snapshots per volume or pool.

vol.snap.assign_qos 

ROLE: Admin 

Description

Assign volume to policy. 

Syntaxvol.snap.assign_qos snap=SNAP[,SNAP,...] policy=QOSVOLUMEPOLICY
ArgumentspolicyQos policy
snapName of an existing volume snapshot (multiple values separated by commas) 
Examplevol.restore name=vol1 snap=snap1
Volume vol1 restored from snapshot snap1



vol.snap.cache 

ROLE: Admin, Pool Admin

Description

Enable or disable SSD cache.

  • The snapshot setting to use the InfiniBox SSD drives is inherited from the volume
  • This command allows setting the snapshot to use/unuse the SSD drives independently of the volume (or parent snapshot)
  • For a snapshot that has child snapshot(s) there is an option to set the SSD usage all down the snapshots tree at once (the snapshot ancestors are not affected)
Syntaxvol.snap.cache snap=SNAP ssd_cache=YESNO [recursive=YESNO]
ArgumentsrecursiveEither yes or no
ssd_cacheEither yes or no
snapName of an existing volume snapshot 
ExampleSetting the snapshot to use SSD
vol.snap.cache snap=v1-s1 ssd_cache=yes
Volume snapshot "v1-s1" is now cached on SSD
ExampleSetting the snapshot - and its descendants - to use SSD
vol.snap.cache snap=v1-s1 ssd_cache=yes recursive=yes
Volume snapshot "v1-s1" and all of its descendants are now cached on SSD



vol.snap.create 

ROLE: Admin, Pool Admin

Description

Create a new volume snapshot.

  • A snapshot can be from a volume or a snapshot
  • The snapshot is created in a read-only state
    • The snapshot state can be changed from read-only to writable
  • Restoring a volume or a snapshot from a snapshot
    • To restore the volume from its snapshot, use the vol.restore command
    • To restore the snapshot from its child snapshot, use the vol.snap.restore command
Syntaxvol.snap.create vol={VOL|SNAP} name=NAME [ssd_cache=YESNO] [lock_duration=DATEDURATION]
Argumentsssd-cacheEither yes or no
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 or snapshot
lock_durationA positive number, followed by a unit; e.g. 1M, 10DAYS 
ExampleTaking a snapshot of a volume
vol.snap.create vol=vol1 snap=snap1
Volume snapshot snap1 created
ExampleCreating a locked snapshot
vol.snap.create vol=vol1 name=s2 lock_duration=1d
Volume snapshot "s2" created, locked until '2018-09-17 11:00:00'
ExampleTaking a snapshot of a snapshot
vol.snap.create vol=snap1 name=snap1-s1
Volume snapshot "snap1-s1" created
ExampleTaking a snapshot and disabling the usage of SSD drives
vol.snap.create vol=snap1 snap=snap1-s1 ssd_cache=no
Volume snapshot "snap1-s1" created



vol.snap.delete 

ROLE: Admin, Pool Admin

Description

Delete volume snapshot.

  • This is a dangerous operation that requires a specific user approval.
Syntaxvol.snap.delete snap=SNAP[,SNAP,...]
ArgumentssnapName of an existing volume snapshot (multiple values, separated by commas)
ExampleDeleting a snapshot
vol.snap.delete snap=v1-s3
Volume snapshot "v1-s3" deleted
Example

Deleting a snapshot that has children

  • The dangerous operation that the user has to approve indicates that the snapshot has children
vol.snap.delete snap=v1-s3
Volume snapshot "v1-s3" deleted



vol.snap.map 

ROLE: Admin, Pool Admin

Description

Map volume snapshot to host or cluster.

  • The LUN is assigned by InfiniBox 
Syntaxvol.snap.map snap=SNAP[,SNAP,...] [host=HOST] [cluster=CLUSTER] [lun=LUN]
ArgumentssnapName of an existing volume snapshot (multiple values, separated by commas)
lunSCSI logical unit number (LUN)
clusterName of an existing cluster 
hostName of an existing host 
Examplevol.snap.map snap=v1-s1-s1 host=h1
Volume snapshot "v1-s1-s1" mapped to LUN 2 in host "h1"



vol.snap.map_query 

ROLE: All Roles

Description

List mappings of snapshots to hosts and clusters.

Syntaxvol.snap.map_query [snap=SNAP[,SNAP,...]] [pool=POOL] [host=HOST] [cluster=CLUSTER]
ArgumentshostName of an existing host
poolName of an existing pool
snapName of an existing volume snapshot (multiple values, separated by commas)
clusterName of an existing cluster 
Examplevol.snap.map_query snap=snap1

NAME   MAPPING TYPE  MAPPED TO  LUN ID
snap1  CLUSTER       cluster1   11



vol.snap.query 

ROLE: All Roles

Description

List existing snapshots.

The output of this command displays all of the snapshots on the InfiniBox system.

  • Use the unit argument to specify the units of the capacity fields of the output. 
Syntaxvol.snap.query [snap=SNAP[,SNAP,...]] [source={VOL|SNAP}] [sg=SG] [pool=POOL] [unit=CAPACITYUNIT] [mapped=YESNO] [write_protected=YESNO]
ArgumentsunitEither yes or no
poolEither yes or no
sg

Name of an existing snapshot group

source

Name of an existing volume or snapshot  (multiple values, separated by commas)

snapName of an existing volume snapshot
write_protectedEither yes or no
mappedEither yes or no
ExampleQuerying for all of the snapshots in the system
vol.snap.query

NAME      THIN  SIZE     USED  ALLOCATED  POOL  WP  MAPPED  LOCK     CREATED 
                                                            STATE    AT 

v1-s1     yes   10.00 GB 0     0          p1    yes yes     lOCKED   2016-04-11 10:00:00
v1-s1-s1  yes   10.00 GB 0     0          p1    yes yes     UNlOCKED 2016-04-11 10:00:00  


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

NAME  POLICY
v1-s1 q1



vol.snap.refresh 

ROLE: Admin, Pool Admin

Description

Refresh a snapshot.

  • This operation refreshes the snapshot with the volume's data, keeping the snapshot metadata as is
  • This operation is a dangerous operation
Syntaxvol.snap.refresh snap=SNAP
ArgumentssnapName of an existing snapshot 
Example
vol.snap.refresh snap=v1-s1
Volume snapshot "v1-s1" refreshed



vol.snap.rename 

ROLE: Admin, Pool Admin

Description

Rename volume snapshot.

Syntaxvol.snap.rename snap=SNAP 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.
snapName of an existing volume snapshot 
Examplevol.snap.rename snap=snap1 new_name=snap2
Volume snapshot snap1 renamed to snap2



vol.snap.resize 

ROLE: Admin, Pool Admin

Description

Resize volume snapshot.

  • The snapshot size can only be increased
  • The snapshot has to be write-enabled
Syntaxvol.snap.resize snap=SNAP size=SIZEPOSITIVEDELTA
ArgumentssnapName of an existing volume snapshot 
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)
ExampleResizing a snapshot
vol.snap.resize snap=s1 size=100g
Volume snapshot "s1" resized
ExampleRunning the command with an input that is identical to the snapshot current size does not fail the command
vol.snap.resize snap=s1 size=100g
Volume snapshot "s1" size is already 100.00 GB



vol.snap.restore 

ROLE: Admin, Pool Admin

Description

Restore a snapshot from one of its snapshots.

  • The restored snapshot has to be in a write_enabled state
  • This is a dangerous operation
Syntaxvol.snap.restore snap=SNAP source=SNAP
ArgumentssourceName of an existing volume snapshot 
snapName of an existing volume snapshot 
Examplevol.snap.restore target=v1-s1 source=v1-s1-s1
Volume snapshot "v1-s1" restored from volume "v1-s1-s1"



vol.snap.secure_lock 

ROLE: Admin, Pool Admin

Description

Locks a snapshot, temporarily preventing its deletion until the provided time, or extends an existing snapshot lock. 

Syntaxvol.snap.secure_lock snap=SNAP lock_duration=DATEDURATION
ArgumentssnapName of an existing volume snapshot 
lock_durationA politive number followed by a unit, e.g.1M, 10DAYS



vol.snap.tree 

ROLE: All Roles

Description

Display the snapshots tree. 

Syntaxvol.snap.tree snap=SNAP [unit=CAPACITYUNIT]
ArgumentsunitB, G (or GB), GiB, T (or TB), TiB or block
snapName of an existing volume snapshot 
Examplevol.snap.tree snap=v1-s1

NAME        TYPE     SIZE     USED  ALLOCATED  POOL  WP  CREATED AT 
v1-s1       SNAPSHOT 10.00 GB 0     0          p1    no  2016-04-11 10:00:00
|v1-s1-s1   SNAPSHOT 10.00 GB 0     0          p1    no  2016-04-11 10:00:00  



vol.snap.unassign_qos  

ROLE: Admin 

Description

Unassign volume from policy. 

Syntaxvol.snap.unassign_qos snap=SNAP[,SNAP,...]
ArgumentssnapName of an existing volume snapshot (multiple values separated by commas) 
Example
vol.snap.unassign_qos snap=v2-s1
Volume 'v2-s1' was unassigned from policy 'q1'



vol.snap.unmap  

ROLE: Admin, Pool Admin

Description

Unmap volume snapshot from host or cluster. 

Syntaxvol.snap.unmap snap=SNAP[,SNAP,...] [host=HOST] [cluster=CLUSTER]
ArgumentsclusterName of an existing cluster
hostName of an existing host
snapName of an existing volume snapshot (multiple values, separated by commas)
Examplevol.snap.unmap snap=snap1
volume snapshot snap1 unmapped from LUN 12 in cluster cluster1



vol.snap.write_enable  

ROLE: Admin, Pool Admin

Description

Enable write access on volume snapshot.

Syntaxvol.snap.write_enable snap=SNAP [recursive=YESNO]
ArgumentsrecursiveEither yes or no
snapName of an existing volume snapshot 
Examplevol.snap.write_enable snap=v1-s1

Volume snapshot "v1-s1" is now write-enabled 



vol.snap.write_protect  

ROLE: Admin, Pool Admin

Description

Disable write access on volume snapshot.

Syntaxvol.snap.protect snap=SNAP [recursive=YESNO]
ArgumentsrecursiveEither yes or no
snapName of an existing volume snapshot 
Examplevol.snap.write_protect snap=v1-s1

Volume snapshot "v1-s1" is now write-protected 



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:44 UTC

Comments