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

Retrieve an initiator group

Contributors
PDFs

GET /protocols/san/igroups/{uuid}

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 DOC Requesting specific fields to learn more.

  • lun_maps.*

  • 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

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 PATCH only; not available in POST. This property defaults to false when the initiator group is created.

initiators

array[igroup_initiator_no_records]

The initiators that are members of the group. Optional in POST.

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.

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

name

string

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

Note that renaming an initiator group must be done in a PATCH request separate from any other modifications.

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.

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.

svm

svm

uuid

string

The unique identifier of the initiator group.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "initiators": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "igroup": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "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": "aix",
  "protocol": "fcp",
  "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

The initiator group in which the initiator is found.

Note that this does not mean that the initiator cannot also be found in other initiator groups.

Name Type Description

_links

_links

uuid

string

The unique identifier of the initiator group.

igroup_initiator_no_records

Name Type Description

_links

_links

igroup

igroup

The initiator group in which the initiator is found.

Note that this does not mean that the initiator cannot also be found in other initiator groups.

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

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.