Skip to main content
A newer release of this product is available.

Retrieve initiator groups

Contributors
PDFs

GET /protocols/san/igroups

Introduced In: 9.6

Retrieves initiator groups.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • connectivity_tracking.*

  • igroups.*

  • lun_maps.*

  • parent_igroups.*

  • target.*

  • lun igroup show

  • lun mapping show

Learn more

Parameters

Name Type In Required Description

name

string

query

False

Filter by name

  • maxLength: 96

  • minLength: 1

lun_maps.lun.uuid

string

query

False

Filter by lun_maps.lun.uuid

lun_maps.lun.name

string

query

False

Filter by lun_maps.lun.name

lun_maps.lun.node.uuid

string

query

False

Filter by lun_maps.lun.node.uuid

lun_maps.lun.node.name

string

query

False

Filter by lun_maps.lun.node.name

lun_maps.logical_unit_number

integer

query

False

Filter by lun_maps.logical_unit_number

supports_igroups

boolean

query

False

Filter by supports_igroups

  • Introduced in: 9.9

target.vendor_id

string

query

False

Filter by target.vendor_id

  • Introduced in: 9.11

target.firmware_revision

string

query

False

Filter by target.firmware_revision

  • Introduced in: 9.11

target.product_id

string

query

False

Filter by target.product_id

  • Introduced in: 9.11

initiators.name

string

query

False

Filter by initiators.name

  • maxLength: 96

  • minLength: 1

initiators.connectivity_tracking.connection_state

string

query

False

Filter by initiators.connectivity_tracking.connection_state

  • Introduced in: 9.11

initiators.comment

string

query

False

Filter by initiators.comment

  • maxLength: 254

  • minLength: 0

  • Introduced in: 9.9

initiators.igroup.name

string

query

False

Filter by initiators.igroup.name

  • maxLength: 96

  • minLength: 1

  • Introduced in: 9.9

initiators.igroup.uuid

string

query

False

Filter by initiators.igroup.uuid

portset.uuid

string

query

False

Filter by portset.uuid

  • Introduced in: 9.9

portset.name

string

query

False

Filter by portset.name

  • maxLength: 96

  • minLength: 1

  • Introduced in: 9.9

parent_igroups.name

string

query

False

Filter by parent_igroups.name

  • maxLength: 96

  • minLength: 1

  • Introduced in: 9.9

parent_igroups.uuid

string

query

False

Filter by parent_igroups.uuid

  • Introduced in: 9.9

parent_igroups.comment

string

query

False

Filter by parent_igroups.comment

  • maxLength: 254

  • minLength: 0

  • Introduced in: 9.9

comment

string

query

False

Filter by comment

  • maxLength: 254

  • minLength: 0

  • Introduced in: 9.9

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

protocol

string

query

False

Filter by protocol

connectivity_tracking.connection_state

string

query

False

Filter by connectivity_tracking.connection_state

  • Introduced in: 9.11

connectivity_tracking.required_nodes.uuid

string

query

False

Filter by connectivity_tracking.required_nodes.uuid

  • Introduced in: 9.11

connectivity_tracking.required_nodes.name

string

query

False

Filter by connectivity_tracking.required_nodes.name

  • Introduced in: 9.11

connectivity_tracking.alerts.summary.target

string

query

False

Filter by connectivity_tracking.alerts.summary.target

  • Introduced in: 9.11

connectivity_tracking.alerts.summary.arguments.message

string

query

False

Filter by connectivity_tracking.alerts.summary.arguments.message

  • Introduced in: 9.11

connectivity_tracking.alerts.summary.arguments.code

string

query

False

Filter by connectivity_tracking.alerts.summary.arguments.code

  • Introduced in: 9.11

connectivity_tracking.alerts.summary.code

string

query

False

Filter by connectivity_tracking.alerts.summary.code

  • Introduced in: 9.11

connectivity_tracking.alerts.summary.message

string

query

False

Filter by connectivity_tracking.alerts.summary.message

  • Introduced in: 9.11

delete_on_unmap

boolean

query

False

Filter by delete_on_unmap

os_type

string

query

False

Filter by os_type

igroups.comment

string

query

False

Filter by igroups.comment

  • maxLength: 254

  • minLength: 0

  • Introduced in: 9.9

igroups.uuid

string

query

False

Filter by igroups.uuid

  • Introduced in: 9.9

igroups.name

string

query

False

Filter by igroups.name

  • maxLength: 96

  • minLength: 1

  • Introduced in: 9.9

uuid

string

query

False

Filter by uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

array[igroup]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "connectivity_tracking": {
        "alerts": [
          {
            "summary": {
              "arguments": [
                {
                  "code": "string",
                  "message": "string"
                }
              ],
              "code": "4",
              "message": "entry doesn't exist",
              "target": "uuid"
            }
          }
        ],
        "connection_state": "string",
        "required_nodes": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        ]
      },
      "igroups": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "comment": "string",
          "igroups": null,
          "name": "igroup1",
          "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "initiators": [
        {
          "_links": {
            "connectivity_tracking": {
              "href": "/api/resourcelink"
            },
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "comment": "string",
          "connectivity_tracking": {
            "connection_state": "string"
          },
          "igroup": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "igroup1",
            "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
          },
          "name": "iqn.1998-01.com.corp.iscsi:name1"
        }
      ],
      "lun_maps": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "logical_unit_number": 0,
          "lun": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "lun1",
            "node": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "node1",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            },
            "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
          }
        }
      ],
      "name": "igroup1",
      "os_type": "string",
      "parent_igroups": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "comment": "string",
          "name": "igroup1",
          "parent_igroups": null,
          "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "portset": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "portset1",
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "protocol": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "target": {
        "firmware_revision": "9111",
        "product_id": "LUN C-Mode",
        "vendor_id": "NETAPP"
      },
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

summary

A user friendly message describing the connection state of the initiator group.

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

alerts

Name Type Description

summary

summary

A user friendly message describing the connection state of the initiator group.

required_nodes

Name Type Description

_links

_links

name

string

uuid

string

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

Name Type Description

alerts

array[alerts]

connection_state

string

Connection state.

required_nodes

array[required_nodes]

Nodes to which the initiators in this group should be connected to ensure reliable service. This is the collection of any node hosting a LUN mapped to this igroup as well as the HA partners of those nodes.

igroup_child

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator.

igroups

array[]

Further nested initiator groups.

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

Name Type Description

href

string

self

A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

Name Type Description

href

string

_links

Name Type Description

connectivity_tracking

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

self

self

A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

connectivity_tracking

Overview of the initiator's connections to ONTAP.

Name Type Description

connection_state

string

Connection state.

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

Name Type Description

_links

_links

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

initiators

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator. Valid in POST and PATCH.

connectivity_tracking

connectivity_tracking

Overview of the initiator's connections to ONTAP.

  • readOnly: 1

  • Introduced in: 9.11

igroup

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

name

string

The FC WWPN, iSCSI IQN, or iSCSI EUI that identifies the host initiator. Valid in POST only and not allowed when the records property is used.

An FC WWPN consists of 16 hexadecimal digits grouped as 8 pairs separated by colons. The format for an iSCSI IQN is iqn.yyyy-mm.reverse_domain_name:any. The iSCSI EUI format consists of the eui. prefix followed by 16 hexadecimal characters.

node

Name Type Description

_links

_links

name

string

uuid

string

lun

The LUN to which the initiator group is mapped.

Name Type Description

_links

_links

name

string

The name of the LUN.

node

node

uuid

string

The unique identifier of the LUN.

lun_maps

A LUN map with which the initiator group is associated.

Name Type Description

_links

_links

logical_unit_number

integer

The logical unit number assigned to the LUN for initiators in the initiator group.

lun

lun

The LUN to which the initiator group is mapped.

igroup_parent

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator.

name

string

The name of the initiator group.

parent_igroups

array[]

The initiator groups that contain this initiator group as as member.

uuid

string

The unique identifier of the initiator group.

portset

The portset to which the initiator group is bound. Binding the initiator group to a portset restricts the initiators of the group to accessing mapped LUNs only through network interfaces in the portset.

Optional in POST and PATCH. PATCH portset.name to an empty string ("") to unbind a portset from the initiator group.

Name Type Description

_links

_links

name

string

The name of the portset.

uuid

string

The unique identifier of the portset.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

target

Properties of the SCSI target to which the initiator group provides access.

Name Type Description

firmware_revision

string

The firmware revision of the SCSI target specific to the OS type of the initiator group.

product_id

string

The product ID of the SCSI target.

vendor_id

string

The vendor ID of the SCSI target.

igroup

An initiator group (igroup) is a collection of Fibre Channel (FC) world wide port names (WWPNs), and/or iSCSI Qualified Names (IQNs), and/or iSCSI EUIs (Extended Unique Identifiers) that identify host initiators.

Initiator groups are used to control which hosts can access specific LUNs. To grant access to a LUN from one or more hosts, create an initiator group containing the host initiator names, then create a LUN map that associates the initiator group with the LUN.

An initiator group may contain either initiators or other initiator groups, but not both simultaneously. When a parent initiator group is mapped, it inherits all of the initiators of any initiator groups nested below it. If any nested initiator group is modified to contain different initiators, the parent initiator groups inherit the change. A parent can have many nested initiator groups and an initiator group can be nested under multiple parents. Initiators can only be added or removed from the initiator group that directly contains them. The maximum supported depth of nesting is three layers.

Best practice when using nested initiator groups is to match host hierarchies. A single initiator group should correspond to a single host. If a LUN needs to be mapped to multiple hosts, the initiator groups representing those hosts should be aggregated into a parent initiator group and the LUN should be mapped to that initiator group. For multi-ported hosts, initiators have a comment property where the port corresponding to the initiator can be documented.

An initiator can appear in multiple initiator groups. An initiator group can be mapped to multiple LUNs. A specific initiator can be mapped to a specific LUN only once. With the introduction of nestable initiator groups, best practice is to use the hierarchy such that an initiator is only a direct member of a single initiator group, and that initiator group can then be referenced by other initiator groups.

All initiators or nested initiator groups in an initiator group must be from the same operating system. The initiator group's operating system is specified when the initiator group is created.

When an initiator group is created, the protocol property is used to restrict member initiators to Fibre Channel (fcp), iSCSI (iscsi), or both (mixed). Initiator groups within a nested hierarchy may not have conflicting protocols.

Zero or more initiators or nested initiator groups can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/initiators endpoint. Initiator groups containing other initiator groups report the aggregated list of initiators from all nested initiator groups, but modifications of the initiator list must be performed on the initiator group that directly contains the initiators. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

Name Type Description

_links

_links

comment

string

A comment available for use by the administrator. Valid in POST and PATCH.

connectivity_tracking

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

  • readOnly: 1

  • Introduced in: 9.11

delete_on_unmap

boolean

An option that causes the initiator group to be deleted when the last LUN map associated with it is deleted. Optional in POST and PATCH. This property defaults to false when the initiator group is created.

igroups

array[igroup_child]

The initiator groups that are members of the group. Optional in POST.

This property is mutually exclusive with the initiators property during POST.

This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the igroups property of the child initiator group.

Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregatation of all initiators in any nested initiator groups.

After creation, nested initiator groups can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/igroups endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.

initiators

array[initiators]

The initiators that are members of the group or any group nested below this group. Optional in POST.

This property is mutually exclusive with the igroups property during POST.

During GET, this array contains initiators that are members of this group or any nested initiator groups below this group. When initiators of nested groups are returned, they include links to the initiator group that directly contains the initiator.

Zero or more initiators can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/initiators endpoint. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

lun_maps

array[lun_maps]

All LUN maps with which the initiator is associated.

If the requested igroup is part of a remote, non-local, MetroCluster SVM, the LUN maps are not retrieved.

There is an added computational cost to retrieving property values for lun_maps. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

name

string

The name of the initiator group. Required in POST; optional in PATCH.

os_type

string

The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH.

parent_igroups

array[igroup_parent]

The initiator groups that contain this initiator group as as member.

portset

portset

The portset to which the initiator group is bound. Binding the initiator group to a portset restricts the initiators of the group to accessing mapped LUNs only through network interfaces in the portset.

Optional in POST and PATCH. PATCH portset.name to an empty string ("") to unbind a portset from the initiator group.

protocol

string

The protocols supported by the initiator group. This restricts the type of initiators that can be added to the initiator group. Optional in POST; if not supplied, this defaults to mixed.

The protocol of an initiator group cannot be changed after creation of the group.

supports_igroups

boolean

An initiator group may contain either initiators or other initiator groups, but not both simultaneously. This property is true when initiator groups can be added to this initiator group. The initiators.name property cannot be used to determine this via a query because it reports initiators inherited from nested igroups.

svm

svm

target

target

Properties of the SCSI target to which the initiator group provides access.

uuid

string

The unique identifier of the initiator group.

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.