RollbackToSnapshot

You can use the RollbackToSnapshot method to make an existing snapshot of the active volume image. This method creates a new snapshot from an existing snapshot.

The new snapshot becomes active and the existing snapshot is preserved until it is manually deleted. The previously active snapshot is deleted unless you set the saveCurrentState parameter to true.

CLUSTER_FULLNESS

Note: 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
volumeID	VolumeID for the volume.	integer	None	Yes
attributes	List of name-value pairs in JSON object format.	JSON attributes	None	No
name	Name for the snapshot. If no name is given, the name of the snapshot being rolled back to is used with "- copy" appended to the end of the name.	string	None	No
snapshotID	ID of a previously created snapshot on the given volume.	integer	None	Yes
saveCurrentState	Specifies whether to save previous active volume image or not. Valid values: true: The previous active volume image is kept. false: The previous active volume image is deleted.	boolean	false	No

Return values

This method has the following return values:

Name	Description	Type
checksum	A small string representation of the data in the stored snapshot.	string
snapshotID	If saveCurrentState was set to false, this value is null. If saveCurrentState was set to true, the unique ID of the newly created snapshot.	integer
snapshot	If saveCurrentState was set to false, this value is null. If saveCurrentState was set to true, an object containing information about the newly created snapshot.	snapshot

Name

Description

Type

checksum

A small string representation of the data in the stored snapshot.

string

snapshotID

If saveCurrentState was set to false, this value is null.

If saveCurrentState was set to true, the unique ID of the newly created snapshot.

integer

snapshot

If saveCurrentState was set to false, this value is null.

If saveCurrentState was set to true, an object containing information about the newly created snapshot.

snapshot

Request example

Requests for this method are similar to the following example:

{
 "method": "RollbackToSnapshot",
 "params": {
    "volumeID": 1,
    "snapshotID": 3114,
    "saveCurrentState": true
  },
  "id": 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {
    "checksum": "0x0",
    "snapshot": {
      "attributes": {},
      "checksum": "0x0",
      "createTime": "2016-04-04T17:27:32Z",
      "enableRemoteReplication": false,
      "expirationReason": "None",
      "expirationTime": null,
      "groupID": 0,
      "groupSnapshotUUID": "00000000-0000-0000-0000-000000000000",
      "name": "test1-copy",
      "snapshotID": 1,
      "snapshotUUID": "30d7e3fe-0570-4d94-a8d5-3cc8097a6bfb",
      "status": "done",
      "totalSize": 5000658944,
      "virtualVolumeID": null,
      "volumeID": 1
    },
    "snapshotID": 1
  }
}

New since version

9.6