CreateVolumeAccessGroup

You can use CreateVolumeAccessGroup to create a new volume access group. When you create the volume access group, you need to give it a name, and you can optionally enter initiators and volumes.

Any initiator IQN that you add to the volume access group is able to access any volume in the group without CHAP authentication.
Note: Cloned volumes do not inherit volume access group membership from the source volume.
Consider the following when you create volume access groups:
  • A volume access group can contain up to 64 initiator IQNs.
  • An initiator can only belong to one volume access group.
  • A volume access group can contain up to 2000 volumes.
  • Each volume access group can belong to a maximum of four other volume access groups.

Parameters

This method has the following input parameters:

Name Description Type Default value Required
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 or string array (deprecated) [] No
name Name of the volume access group. Not required to be unique, but recommended. Must be 1 to 64 characters in length. string None Yes
volumes List of volumeIDs to include in the volume access group. integer array [] No
attributes List of name-value pairs in JSON object format. JSON object {} No

Return values

This method has the following return values:

Name Description Type
volumeAccessGroup An object containing information about the newly created volume access group. volumeAccessGroup
volumeAccessGroupID The ID of the newly created volume access group. integer

Request example

Requests for this method are similar to the following example:

{
   "method": "CreateVolumeAccessGroup",
   "params": {
      "name": "myaccessgroup",
      "initiators": ["iqn.1993-08.org.debian: 01: a31b1d799d5c"],
      "volumes": [327],
      "attributes": {}
   }
}

Response example

This method returns a response similar to the following example:

{
  "id": null,
  "result": {
    "volumeAccessGroup": {
      "attributes": {},
      "deletedVolumes": [],
      "initiatorIDs": [
        95
      ],
      "initiators": [
        "iqn.1993-08.org.debian: 01: a31b1d799d5c"
      ],
      "name": "myaccessgroup",
      "volumeAccessGroupID": 96,
      "volumes": [
        327
      ]
    },
    "volumeAccessGroupID": 96
  }
}