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.
Replicated consistency group
| |
| Syntax | cg.add_member cg=CG member=VOL[,VOL,...] [target=REMOTEENTITY[,REMOTEENTITY,...]] [new_target_name=NAME[,NAME,...]] | |
| Arguments | cg | Name of an existing consistency group |
member | Name of an existing volume (multiple values, separated by commas) | |
target | Name of a remote entity (auto-completion unavailable) (multiple values, separated by commas) | |
new_target_name | A 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 | ||
| Example | In 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. | |
| Syntax | cg.create name=NAME [pool=STANDARDPOOL] | |
| Arguments | name | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. |
pool | Name of an standard pool. | |
| Example | cg.create name=cg1 | |
Consistency group cg1 created | ||
cg.delete
ROLE: Admin, Pool Admin
| Description | Delete a consistency group. | |
| Syntax | cg.delete cg=CG[,CG,...] [delete_members=YESNO] | |
| Arguments | cg | Name of an existing consistency group (multiple values, separated by commas) |
delete_members | Either yes or no | |
| Example | cg.delete name=cg1 | |
Consistency group cg1 deleted | ||
cg.member_query
ROLE: All Roles
| Description | List all cg members. | |
|---|---|---|
| Syntax | cg.member_query [cg=CG[,CG,...]] | |
| Arguments | cg | Name of an existing consistency group (multiple values, separated by commas) |
| Example | ||
cg.member_query name=cg1 | ||
NAME SIZE USED ALLOCATED MAPPED | ||
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 |
| |
| Arguments | cg | Name of an existing consistency group |
move_capacity | Either yes or no | |
pool | Name of an existing standard pool | |
| Example | In 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 | ||
| Example | In 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. | |
| Syntax | cg.query [cg=CG[,CG,...]] [pool=STANDARDPOOL] [member=VOL] | |
| Arguments | cg | Name of an existing consistency group (multiple values, separated by commas) |
member | Name of an existing member | |
pool | Name of an existing standard pool | |
| Example | cg.query | |
NAME POOL MEMBERS REPLICATED | ||
cg.remove_member
ROLE: Admin, Pool Admin
| Description | Remove a member from a consistency group. This command removes a member from a consistency group.
Removing a member of a replicating consistency group can be done as follows:
The command is a dangerous operation and requires an approval. | |
| Syntax | cg.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}] | |
| Arguments | create_new_replica | Either yes or no |
force | Either yes or no | |
retain_staging_area | Either yes or no | |
member | Name of an existing volume | |
cg | Name of an existing consistency group | |
force_keep_serial | Either yes or no | |
| Example | In 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 | ||
| Example | In 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. | |
| Syntax | cg.rename cg=CG new_name=NAME | |
| Arguments | new_name | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. |
cg | Name of an existing consistency group | |
| Example | cg.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. | |
| Syntax | cg.restore cg=CG source=SG | |
| Arguments | source | Name of an existing snapshot group |
cg | Name of an existing consistency group | |
| Example | cg.restore name=cg1 source=sg1 | |
Consistency group cg1 restored from snapshot group sg1 | ||
Last edited: 2022-08-06 08:32:18 UTC
Comments