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

Retrieve an initiator group

Contributors
PDFs

GET /protocols/san/igroups/{uuid}

Introduced In: 9.6

Retrieves an initiator group.

Expensive properties

There is an added 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.

  • igroups.*

  • lun_maps.*

  • parent_igroups.*

  • lun igroup show

  • lun mapping show

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the initiator group.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

comment

string

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

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 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

uuid

string

The unique identifier of the initiator group.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "igroups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "igroups": null,
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "initiators": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "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"
  },
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374852

The initiator group does not exist.
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

self

href

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.

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.

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.