You can use the ModifyVolumeAccessGroup method to update initiators and add or remove volumes from a volume access group.
If a specified initiator or volume is a duplicate of what currently exists, the volume access group is left as-is. If you do not specify a value for volumes or initiators, the current list of initiators and volumes is not changed.
You can also associate a virtual network with a volume access group. This association applies to all volumes in the volume access group.
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
volumeAccessGroupID | The ID of the volume access group to modify. | integer | None | Yes |
name | The new name for this volume access group. | string | None | No |
attributes | List of name-value pairs in JSON object format. | JSON object | None | No |
initiators | List of initiator IDs or names (IQNs and WWPNs) to include in the volume access group. If you pass a list of initiator names, the initiators are created if they do not already exist. If you pass a list of initiator IDs, the method returns an error if any of the initiators does not already exist. Passing initiator names is deprecated; you should use initiator IDs whenever possible. | integer array (recommended) or string array (deprecated) | None | No |
deleteOrphanInitiators | Specifies whether to delete initiator objects after they are removed from a volume access group or not. Possible values:
|
boolean | false | No |
volumes | A list of volume IDs of volumes to modify. | integer array | None | volumeAccessGroup |
This method has the following return value:
Name | Description | Type |
---|---|---|
volumeAccessGroup | An object containing information about the newly modified volume access group. | volumeAccessGroup |
Requests for this method are similar to the following example:
{ "method": "ModifyVolumeAccessGroup", "params": { "volumeAccessGroupID": 96, "name": "accessgrouptest", "initiators": [115,114], "volumes": [ 346 ], "attributes": {} } }
This method returns a response similar to the following example:
{ "id": null, "result": { "volumeAccessGroup": { "attributes": {}, "deletedVolumes": [ 327 ], "initiatorIDs": [ 114, 115 ], "initiators": [ "iqn.1998-01.com.vmware:desk1-esx1-577b283a", "iqn.1998-01.com.vmware:donesq-esx1-421b281b" ], "name": "accessgrouptest", "volumeAccessGroupID": 96, "volumes": [ 346 ] } } }
9.6