Get iGroups

Contributors netapp-ranuk

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:

Get iGroups for single node

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

1. Select the working environment

Perform the workflow Create Azure single node working environment and choose the publicId and svmName values for the working environment 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://cloudmanager.cloud.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 high availability pair

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

1. Select the working environment

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

2. Get the CIFS configurations

HTTP method Path

GET

/occm/api/azure/ha/volumes/igroups/{workingEnvironmentId}/{svmName}

curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/azure/ha/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"
        ]
    }
]