NetApp ONTAP SAN icon

NetApp ONTAP SAN

Manage NetApp ONTAP LUNs, igroups, FC interfaces, and protocols

Actions36

Igroup → Get

AI-generated

Summary

Retrieve detailed information about a specific initiator group (igroup) from a NetApp ONTAP SAN cluster by specifying the cluster connection and the igroup to fetch.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF.
  • Port — HTTPS port for the ONTAP REST API, defaults to 443.
  • Igroup (required) — Identifier for the igroup to retrieve. Can be specified either by UUID or by Name.
  • Options — Optional parameters including a 'Fields' string to specify a comma-separated list of fields to include in the response (use '*' for all fields).

Output shape

a single JSON object containing the detailed properties of the specified igroup

The operation makes a GET request to the ONTAP REST API endpoint /protocols/san/igroups/{igroupId} and returns the igroup details. If the igroup is specified by name, the node resolves it to a UUID before the retrieval. Errors during lookup or retrieval will cause the node to throw unless continued on fail is enabled.

Examples

Example 1: Get igroup details by UUID with all fields

Cluster Host: cluster.example.com; Port: 443; Igroup specified by UUID; Options Fields set to '*' for all fields

Example 2: Get igroup details by Name with limited fields

Cluster Host: cluster.example.com; Igroup specified by name 'myIgroup'; Options Fields set to 'name,protocol,os_type'

Links

Discussion