Follow

Consistency group commands allow to group datasets together and take snapshots for all of the members at the same point-in-time.


cg.add_member 

ROLE: Admin, Pool Admin

Description

Add a member to a consistency group.

This command adds a member to a consistency group.

  • A snapshot group that is taken after the member addition will include a snapshot for this new member
  • Any snapshot group that was taken prior to the member addition does not include a snapshot for this new member, thus is considered inconsistent with the consistency group

Replicated consistency group

  • Adding a non-replicating volume to a replicating consistency group breaks its replication consistency.
  • In such a case, the consistency group replica on the target will be considered consistent as of the next sync job.
  • Adding a dataset other than volume is impossible.
Syntaxcg.add_member cg=CG member=VOL[,VOL,...] [target=REMOTEENTITY[,REMOTEENTITY,...]] [new_target_name=NAME[,NAME,...]]
ArgumentscgName of an existing consistency group
memberName of an existing volume (multiple values, separated by commas)
targetName of a remote entity (auto-completion unavailable) (multiple values, separated by commas)
new_target_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)
Example

In this example, a single volume is added to a consistency group.

cg.add_member name=cg1 members=vol1
Volume vol1 added to consistency group cg1
ExampleIn this example, three volumes are added to a consistency group.
cg.add_member name=cg1 members=vol1,vol2,vol3
3 members added to consistency group cg1



cg.create  

ROLE: Admin, Pool Admin

Description

Create a new consistency group. 

Syntaxcg.create name=NAME [pool=STANDARDPOOL]
ArgumentsnameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. 
poolName of an standard pool.
Examplecg.create name=cg1
Consistency group cg1 created



cg.delete  

ROLE: Admin, Pool Admin

Description

Delete a consistency group.

Syntaxcg.delete cg=CG[,CG,...] [delete_members=YESNO]
ArgumentscgName of an existing consistency group (multiple values, separated by commas)
delete_membersEither yes or no 
Examplecg.delete name=cg1 
Consistency group cg1 deleted 



cg.member_query  

ROLE: All Roles

Description

List all cg members. 

Syntaxcg.member_query [cg=CG[,CG,...]]
ArgumentscgName of an existing consistency group (multiple values, separated by commas)
Example
cg.member_query name=cg1

NAME    SIZE      USED     ALLOCATED  MAPPED
vol-01  10.00 TB  9.83 TB  9.83 TB    yes
vol-02  10.00 TB  9.83 TB  9.83 TB    yes
vol-03  10.00 TB  9.83 TB  9.83 TB    yes



cg.move  

ROLE: Admin, Pool Admin 

Description

Move a consistency group to a different pool.

Move a consistency group from one pool or another with or without its members. See the examples below. The association of the members with a pool can be verified using the vol.query command. 

Syntax

cg.move cg=CG pool=STANDARDPOOL [move_capacity={YES|NO|Y|N}]

ArgumentscgName of an existing consistency group
move_capacityEither yes or no
poolName of an existing standard pool 
ExampleIn this example, the consistency group - and its volumes - move to another pool without their capacity. 
cg.move name=cg1 pool=pool2
Consistency group cg1 moved to pool pool2 without its capacity
ExampleIn this example, the consistency group - and its volumes - move to another pool with their capacity.
cg.move name=cg1 pool=pool1 move_capacity=yes
Consistency group cg1 moved to pool pool1 along with its capacity
Example

This example is similar to the first. In this example, the consistency group - and its volumes - move to another pool without their capacity.

cg.move name=cg1 pool=pool2 move_capacity=no
Consistency group cg1 moved to pool pool2 without its capacity



cg.query  

ROLE: All Roles

Description

List existing consistency groups.

Query consistency groups by name, the pool they belong to, or dataset members.

Syntaxcg.query [cg=CG[,CG,...]] [pool=STANDARDPOOL] [member=VOL]
ArgumentscgName of an existing consistency group (multiple values, separated by commas)
memberName of an existing member
poolName of an existing standard pool 
Examplecg.query
NAME   POOL   MEMBERS   REPLICATED 
cq1    pool1  1         yes
cq2    pool2  2         no



cg.remove_member  

ROLE: Admin, Pool Admin

Description

Remove a member from a consistency group.

This command removes a member from a consistency group.

  • A snapshot group that is taken after the member removal will not include a snapshot for the removed member
  • Any snapshot group that was taken prior to the member removal is no longer consistent with the consistency group

Removing a member of a replicating consistency group can be done as follows:

  • Using the create_new_replica flag removes the source member from the source consistency group, removes the target member from the target consistency group and keeps them replicating independently
  • Using retain_staging_area (available for asynchronous replica only) - removes the members from their consistency groups and exposes their snapshots
    • The created snapshot has the following prefix auto-reclaim
  • Using the force flag - removes the member only from the source consistency group
    • The removed member is no longer replicated
    • The target member remains on the target consistency group and has to be removed manually from the target side

The command is a dangerous operation and requires an approval.  

Syntaxcg.remove_member cg=CG member=VOL [retain_staging_area=YES|NO|Y|N}] [force=YES|NO|Y|N}] [create_new_replica=YES|NO|Y|N}] [force_keep_serial=YES|NO|Y|N}]
Argumentscreate_new_replica Either yes or no
force Either yes or no
retain_staging_areaEither yes or no
member Name of an existing volume
cgName of an existing consistency group
force_keep_serialEither yes or no
ExampleIn this example, a single volume is removed from a consistency group.
cg.remove_member name=cg1 members=vol1
Volume vol1 removed from consistency group cg1
ExampleIn this example, three volumes were removed from a consistency group.
cg.remove_member name=cg1 members=vol1,vol2,vol3
3 members removed from consistency group cg1
Example

Removing a member using the force flag
cg.remove_member cg=cg1 member=vol1 force=yes
Volume "vol1" removed from consistency group "cg1", and its staging area discarded
Example


Removing a member using the create_new_replica flag
cg.remove_member cg=cg1 member=vol1 create_new_replica=yes
Volume "vol1" removed from consistency group "cg1", and its staging area discarded
Example


Removing a member using the retain_staging_area flag
cg.remove_member cg=cg1 member=vol1 retain_staging_area=yes
Volume "vol1" removed from consistency group "cg1", and its staging area retained



cg.rename  

ROLE: Admin, Pool Admin

Description

Rename a consistency group.

Syntaxcg.rename cg=CG 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.
cgName of an existing consistency group 
Examplecg.rename name=cg1 new_name=cg2
Consistency group cg1 renamed to cg2



cg.restore  

ROLE: Admin, Pool Admin

Description

Restore a consistency group from one of its snapshot groups.

Syntaxcg.restore cg=CG source=SG
ArgumentssourceName of an existing snapshot group
cgName of an existing consistency group 
Examplecg.restore name=cg1 source=sg1
Consistency group cg1 restored from snapshot group sg1



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

Comments