ListVolumeAccessGroups

Contributors netapp-mwallis ntap-bmegan Download PDF of this page

You can use the ListVolumeAccessGroups method to get information about the volume access groups that are currently in the system.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

limit

Maximum number of volumeAccessGroup objects to return. Mutually exclusive with the volumeAccessGroups parameter.

integer

Unlimited

No

startVolumeAccessGroupID

The volume access group ID at which to begin the listing. Mutually exclusive with the volumeAccessGroups parameter.

integer

0

No

volumeAccessGroups

List of volumeAccessGroupID values to retrieve. Mutually exclusive with the startVolumeAccessGroupID and limit parameters.

integer array

No

Return values

This method has the following return values:

Name

Description

Type

volumeAccessGroups

A list of objects describing each volume access group.

volumeAccessGroupsNotFound

A list of volume access groups not found by the system. Present if you used the volumeAccessGroups parameter and the system was unable to find one or more volume access groups that you specified.

integer array

Request example

Requests for this method are similar to the following example:

{
   "method": "ListVolumeAccessGroups",
   "params": {
      "startVolumeAccessGroupID": 3,
      "limit"   : 1
   },
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {
    "volumeAccessGroups": [
      {
        "attributes": {},
        "deletedVolumes": [],
        "initiatorIDs": [],
        "initiators": [],
        "name": "example1",
        "volumeAccessGroupID": 3,
        "volumes": []
      }
    ]
  }
}

New since version

9.6