You can use ModifyGroupSnapshot to change the attributes of a group of snapshots. You can also use this method to enable snapshots created on the read/write (source) volume to be remotely replicated to a target storage system.
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
enableRemoteReplication | Use to enable the snapshot created to be replicated to a remote cluster. Possible values:
|
boolean | false | No |
expirationTime | Use to set the time when the snapshot should be removed. If no time is entered, the current time will be used. When set to "null", the snapshot never expires. | ISO 8601 date string | None | No |
name | 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 |
groupSnapshotID | The ID of the group of snapshots. | string | None | Yes |
snapMirrorLabel | The label used by SnapMirror software to specify the snapshot retention policy on a SnapMirror endpoint. | string | None | No |
This method has the following return value:
Name | Description | Type |
---|---|---|
groupSnapshot | Object containing information about the newly modified group snapshot. | groupSnapshot |
Requests for this method are similar to the following example:
{ "id": 695, "method": "ModifyGroupSnapshot", "params": { "groupSnapshotID": 3, "enableRemoteReplication": true, "expirationTime": "2016-04-08T22:46:25Z" } }
This method returns a response similar to the following example:
{ "id": 695, "result": { "groupSnapshot": { "attributes": {}, "createTime": "2016-04-06T17:31:41Z", "groupSnapshotID": 3, "groupSnapshotUUID": "8b2e101d-c5ab-4a72-9671-6f239de49171", "members": [ { "attributes": {}, "checksum": "0x0", "createTime": "2016-04-06T17:31:41Z", "enableRemoteReplication": true, "expirationReason": "None", "expirationTime": "2016-04-08T22:46:25Z", "groupID": 3, "groupSnapshotUUID": "8b2e101d-c5ab-4a72-9671-6f239de49171", "name": "grpsnap1-2", "snapshotID": 2, "snapshotUUID": "719b162c-e170-4d80-b4c7-1282ed88f4e1", "status": "done", "totalSize": 1000341504, "virtualVolumeID": null, "volumeID": 2 } ], "name": "grpsnap1", "status": "done" } } }
9.6