You can use CreateSnapshot to create a point-in-time copy of a volume. You can create a snapshot from any volume or from an existing snapshot.
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
attributes | List of name-value pairs in JSON object format. | JSON object | None | No |
enableRemoteReplication | Specifies whether the snapshot will be replicated to remote storage or not. Possible values:
|
boolean | false | No |
name | The name of the snapshot. If no name is entered, the date and time the snapshot was taken is used. The maximum name length allowed is 255 characters. | string | None | No |
retention | The amount of time the snapshot will be retained. If left empty, the snapshot is retained forever. Enter in the HH:mm:ss format. | string | None | No |
snapMirrorLabel | The label used by SnapMirror software to specify the snapshot retention policy on a SnapMirror endpoint. | string | None | No |
snapshotID | Unique ID of a snapshot from which the new snapshot is made. The snapshotID passed must be a snapshot on the given volume. | integer | None | No |
volumeID | Unique ID of the volume image from which to copy. | integer | None | Yes |
This method has the following return values:
Name | Description | Type |
---|---|---|
checksum | A string that represents the correct digits in the stored snapshot. This checksum can be used later to compare other snapshots to detect errors in the data. | string |
snapshotID | Unique ID of the new snapshot. | Snapshot ID |
snapshot | An object containing information about the newly created snapshot. | snapshot |
Requests for this method are similar to the following example:
{ "method": "CreateSnapshot", "params": { "volumeID": 1 }, "id": 1 }
This method returns a response similar to the following example:
{ "id": 1, "result": { "checksum": "0x0", "snapshot": { "attributes": {}, "checksum": "0x0", "createTime": "2016-04-04T17:14:03Z", "enableRemoteReplication": false, "expirationReason": "None", "expirationTime": null, "groupID": 0, "groupSnapshotUUID": "00000000-0000-0000-0000-000000000000", "name": "2016-04-04T17:14:03Z", "snapshotID": 3110, "snapshotUUID": "6f773939-c239-44ca-9415-1567eae79646", "status": "done", "totalSize": 5000658944, "virtualVolumeID": null, "volumeID": 1 }, "snapshotID": 3110 } }
9.6