CreateGroupSnapshot
You can use CreateGroupSnapshot
to create a point-in-time copy of a group of volumes.
You can use this snapshot later as a backup or rollback to ensure the data on the group of volumes is consistent for the point in time that you created the snapshot.
CLUSTER_FULLNESS
You can create snapshots if cluster fullness is at stage 1, 2, or 3. You cannot create snapshots when cluster fullness reaches stage 4 or 5. |
Parameters
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
|
List of name-value pairs in JSON object format. |
JSON object |
None |
No |
|
Specifies whether the snapshot will be replicated to remote storage or not. Possible values:
|
boolean |
false |
No |
|
Specifies that the snapshot should not be created if a previous snapshot replication is in progress. Possible values are:
|
boolean |
|
No |
|
Specify the time after which the snapshot can be removed. Cannot be used with |
ISO 8601 date string |
None |
No |
|
The name of the group snapshot. If no name is entered, the date and time the group snapshot was taken is used. The maximum name length allowed is 255 characters. |
string |
None |
No |
|
This parameter is same as the |
string |
None |
No |
|
The label used by SnapMirror software to specify the snapshot retention policy on a SnapMirror endpoint. |
string |
None |
No |
|
Unique ID of the volume image from which to copy. |
volumeID array |
None |
Yes |
Return values
This method has the following return values:
Name |
Description |
Type |
members |
List of checksum, volumeIDs, and snapshotIDs for each member of the group. Valid values:
|
JSON object array |
groupSnapshotID |
Unique ID of the new group snapshot. |
groupSnapshot ID |
groupSnapshot |
Object containing information about the newly created group snapshot. |
Request example
Requests for this method are similar to the following example:
{ "method": "CreateGroupSnapshot", "params": { "volumes": [1,2] }, "id": 1 }
Response example
This method returns a response similar to the following example:
{ "id": 1, "result": { "groupSnapshot": { "attributes": {}, "createTime": "2016-04-04T22:43:29Z", "groupSnapshotID": 45, "groupSnapshotUUID": "473b78a3-ef85-4541-9438-077306b2d3ca", "members": [ { "attributes": {}, "checksum": "0x0", "createTime": "2016-04-04T22:43:29Z", "enableRemoteReplication": false, "expirationReason": "None", "expirationTime": null, "groupID": 45, "groupSnapshotUUID": "473b78a3-ef85-4541-9438-077306b2d3ca", "name": "2016-04-04T22:43:29Z", "snapshotID": 3323, "snapshotUUID": "7599f200-0092-4b41-b362-c431551937d1", "status": "done", "totalSize": 5000658944, "virtualVolumeID": null, "volumeID": 1 }, { "attributes": {}, "checksum": "0x0", "createTime": "2016-04-04T22:43:29Z", "enableRemoteReplication": false, "expirationReason": "None", "expirationTime": null, "groupID": 45, "groupSnapshotUUID": "473b78a3-ef85-4541-9438-077306b2d3ca", "name": "2016-04-04T22:43:29Z", "snapshotID": 3324, "snapshotUUID": "a0776a48-4142-451f-84a6-5315dc37911b", "status": "done", "totalSize": 6001000448, "virtualVolumeID": null, "volumeID": 2 } ], "name": "2016-04-04T22:43:29Z", "status": "done" }, "groupSnapshotID": 45, "members": [ { "checksum": "0x0", "snapshotID": 3323, "snapshotUUID": "7599f200-0092-4b41-b362-c431551937d1", "volumeID": 1 }, { "checksum": "0x0", "snapshotID": 3324, "snapshotUUID": "a0776a48-4142-451f-84a6-5315dc37911b", "volumeID": 2 } ] } }
New since version
9.6