DeleteSnapshot

You can use the DeleteSnapshot method to delete a snapshot.

A snapshot that is currently the active snapshot cannot be deleted. You must rollback and make another snapshot active before the current snapshot can be deleted.

Parameters

This method has the following input parameters:

Name Description Type Default value Required
snapshotID The ID of the snapshot to delete. integer None Yes
overrideSnapMirrorHold Override the lock placed on snapshots during replication. You can use this parameter to delete stale SnapMirror snapshots after the associated SnapMirror relationship has been deleted. boolean false No

Return values

This method has no return values.

Request example

Requests for this method are similar to the following example:

{
   "method": "DeleteSnapshot",
"params": {
"snapshotID": 8,
"overrideSnapMirrorHold": true
},
"id": 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {}
}