Skip to main content

Retrieve all igroups

Retrieves all igroups, providing details about the initiator groups configured in the system. Use this to review or manage access control for connected hosts.

HTTP method and endpoint

GET /azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}

Parameters

Name Type In Required Description

workingEnvironmentId

string

path

True

svmName

string

path

True

Error

Status: Default, Default response
Name Type Required Description

igroupName

string

True

igroupType

string

True

initiators

array[string]

True

initiatorsWithConnStatus

array[InitiatorsConnectivityStateNameObject]

True

lunMaps

array[LunMapsLun]

True

osType

string

False

portsetName

string

False

Example error response
{
  "igroupName": "string",
  "igroupType": "string",
  "initiators": [
    "string"
  ],
  "initiatorsWithConnStatus": [
    {
      "connectivity_tracking": {
        "connection_state": "string"
      },
      "name": "string"
    }
  ],
  "lunMaps": [
    {
      "lun": {
        "name": "string",
        "uuid": "string"
      }
    }
  ],
  "osType": "string",
  "portsetName": "string"
}

Definitions

See Definitions

ConnectionState

Name Type Required Description

connection_state

string

False

InitiatorsConnectivityStateNameObject

Name Type Required Description

connectivity_tracking

ConnectionState

True

name

string

False

NameUuidObject

Name Type Required Description

name

string

False

uuid

string

False

LunMapsLun

Name Type Required Description

lun

NameUuidObject

True