DeleteGroupSnapshot

05/26/2022 Contributors

You can use DeleteGroupSnapshot to delete a group snapshot.

You can use the saveMembers parameter to preserve all the snapshots that were made for the volumes in the group, but the group association will be removed.

Parameters

This method has the following input parameters:

Name	Description	Type	Default value	Required
groupSnapshotID	Unique ID of the group snapshot.	integer	None	Yes
saveMembers	Specifies what to delete when you delete a group snapshot. Valid values: true: Snapshots are kept, but the group association is removed. false: The group and snapshots are deleted.	boolean	false	No

Name

Description

Type

Default value

Required

groupSnapshotID

Unique ID of the group snapshot.

integer

None

Yes

saveMembers

Specifies what to delete when you delete a group snapshot. Valid values:

true: Snapshots are kept, but the group association is removed.
false: The group and snapshots are deleted.

boolean

false

Return value

This method has no return value.

Request example

Requests for this method are similar to the following example:

{
   "method": "DeleteGroupSnapshot",
     "params": {
       "groupSnapshotID": 10,
       "saveMembers" : true
        },
     "id": 1
}

Response example

This method returns a response similar to the following example:

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

New since version

9.6