DeleteVolumeAccessGroup

You can use DeleteVolumeAccessGroup to delete a volume access group.

Parameters

This method has the following input parameters:

Name Description Type Default value Required
volumeAccessGroupID The ID of the volume access group to be deleted. integer None Yes
deleteOrphanInitiators Specifies whether to delete initiator objects or not. Possible values:
  • true: Delete initiator objects after they are removed from a volume access group.
  • false: Do not delete initiator objects after they are removed from a volume access group. This is the default.
boolean false No
force Adding this flag will force the volume access group to be deleted even though it has a Virtual Network ID or Tag. Possible values:
  • true: Volume access group will be deleted.
  • false: Default. Do not delete the volume access group if it has a Virtual Network ID or Tag.
boolean false No

Return values

This method does not have return values.

Request example

Requests for this method are similar to the following example:

{
   "method": "DeleteVolumeAccessGroup",
   "params": {
          "force": true,
	  "volumeAccessGroupID"  : 3
   },
   "id" : 1
}

Response example

This method returns a response similar to the following example:

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