Get iGroups

09/29/2025 Contributors

You can use this workflow to retrieve all the initiator groups (iGroups). iGroups is a collection of initiators (iSCSI clients). The iGroups information is required when creating a volume with the iSCSI protocol using an existing iGroup.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Get iGroups for a single node

You can use this workflow to retrieve iGroups for a single node system.

1. Select the system

Perform the workflow Create Azure single node system and choose the publicId and svmName values for the system workingEnvironmentId and svmName path parameters.

2. Get the iGroups configuration

HTTP method	Path
GET	/occm/api/azure/vsa/volumes/igroups/{workingEnvironmentId}/{svmName}

curl example

curl --location --request GET 'https://api.bluexp.netapp.com/occm/api/azure/vsa/volumes/igroups/<WORKING_ENV_ID>/<SVM_NAME>' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' --header 'Content-Type: application/json'

Input

Path parameter <WORKING_ENV_ID> workingEnvironmentId string
Path parameter <SVM_NAME> svmName string

Output

The JSON output example includes a list of iGroups.

JSON output example

[
    {
        "igroupName": "zivIgroup1",
        "osType": "linux",
        "portsetName": "",
        "igroupType": "iscsi",
        "initiators": [
            "iqn.1994-05.com.redhat:0x0xx000000x"
        ]
    },
    {
        "igroupName": "zivIgroup2",
        "osType": "linux",
        "portsetName": "",
        "igroupType": "iscsi",
        "initiators": [
            "iqn.1994-05.com.redhat:0x0xx000000x"
        ]
    }
]

Get iGroups for a high availability pair

You can use this workflow to retrieve iGroups for an HA system.