Follow

Snapshot Groups commands allow to create a group of snapshot per consistency group. The members of the snapshot group are snapshots, taken one per each memeber of the consistency group.


cg.snap.create  

ROLE: Admin, Pool Admin

Description

Create a snapshot of a consistency group.

The snapshot group includes a snapshot group entity and individual snapshots for each of the datasets of the consistency gorup.

  • Provide the name of the consistency group, a name for the new snapshot group, and either a prefix or a suffix for the individual snapshots.
  • As the maximum length of a consistency group is 65 characters, the length of the prefix, or suffix, has to take into consideration the length of the longest consistency group member.
Syntaxcg.snap.create cg=CG name=NAME [snap_prefix=NAME] [snap_suffix=NAME] [lock_duration=DATEDURATION]
Argumentssnap_suffixA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
snap_prefixA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
cgName of an existing consistency group
lock_durationA positive number, followed by a unit; e.g. 1M, 10DAYS
Examplecg.snap.create sg=sg1 source=cg1 snap_suffix=pre-initialization
Snapshot group sg1 created



cg.snap.delete 

ROLE: Admin, Pool Admin

Description

Delete a snapshot group.

This command deletes a snapshot group with or without its members. An approval is required for this operation.

  • This is a dangerous operation that requires a specific user approval.   
Syntaxcg.snap.delete sg=SG[,SG,...] [delete_members=YESNO]
Argumentsdelete_membersEither yes or no
sgName of an existing snapshot group (multiple values, separated by commas)
ExampleIn this example, a snapshot group is deleted and its snapshots remain.
cg.snap.delete sg=sg1 
Snapshot group sg1 deleted 
ExampleIn this example, a snapshot group is deleted and its snapshots are deleted as well. 
cg.snap.delete sg=sg1 delete_members=yes 
Snapshot group sg1 deleted 



cg.snap.member_query   

ROLE: All Roles 

Description

List all members of a snapshot group. 

Syntaxcg.snap.member_query [sg=SG[,SG,...]] 
ArgumentssgName of an existing snapshot group (multiple values, separated by commas) 
Example
cg.snap.member_query sg=sg1
NAME    DATASET TYPE  THIN  SIZE
snap-1  SNAPSHOT      yes   1.00 GB
snap-2  SNAPSHOT      yes   1.00 GB
snap-3  SNAPSHOT      yes   1.00 GB



cg.snap.query  

ROLE: All Roles 

Description

List existing snapshot groups.

Syntaxcg.snap.query [sg=SG[,SG,...]] [source=CG] [expiry_date_from=TIMESTAMP] [expiry_date_to=TIMESTAMP] [pool=STANDARDPOOL] [member=SNAP] [lock=Lock type] 
ArgumentssgName of an existing snapshot group (multiple values, separated by commas) 

lockEXPIRED, LOCKED or UNLOCKED

memberName of an existing volume snapshot

poolName of an existing standard pool

expiry_date_toA timestamp, e.g: '2011-04-13', '2011-04-13 18:30:12'

expiry_date_fromA timestamp, e.g: '2011-04-13', '2011-04-13 18:30:12'

sourceName of an existing consistency group
Example
cg.snap.query
NAME    POOL   MEMBERS 
sg-1    pool1  1
sq-2    pool2  2 



cg.snap.refresh  

ROLE: Admin, Pool Admin 

Description

This command refreshes all of the members of a snapshot group from the members of the consistency group.

  • This command is a dangerous operation.
Syntaxcg.snap.refresh sg=SG 
ArgumentssgName of an existing snapshot group 
Example
cg.snap.refresh sg=cg1-sg1 
Snapshot group "cg1-sg1" refreshed 



cg.snap.rename  

ROLE: Admin, Pool Admin 

Description

Rename a snapshot group. 

Syntaxcg.snap.rename sg=SG 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.
sgName of an existing snapshot group 
Example
cg.snap.rename sg=sg1 new_name=sg2
Snapshot group sg1 renamed to sg2



cg.snap.secure_lock 

ROLE: Admin, Pool Admin 

Description

Locks a snapshot group, temporarily preventing its deletion until the provided time.

The lock duration can be set either upon the snapshot creation or through running this command.

This is a dangerous operation. The lock, or extend, operation has to be acknowledged.

Available duration units:

  • Day
  • Week
  • Month
  • Year

The lock duration cannot be reduced.

Syntaxcg.snap.secure_lock sg=SG lock_duration=DATEDURATION 
Argumentslock_duration A positive number, followed by a unit; e.g. 1M, 10DAYS
sgName of an existing snapshot group 
Example
cg.snap.lock sg=cg1s1 lock_duration=1d 
Snapshot group "cg1s1" is locked until '2018-09-16 10:00:00' 



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

0 out of 0 found this helpful

Last edited: 2022-08-06 08:32:23 UTC

Comments