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

Retrieve a nested initiator group of an initiator group

Contributors
PDFs

GET /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}

Introduced In: 9.9

Retrieves a nested initiator group of an initiator group.

This API only reports the nested initiator groups that are direct children of the initiator group. Further nested initiator groups are reported by their direct parent initiator group.

  • lun igroup show

Learn more

Parameters

Name Type In Required Description

igroup.uuid

string

path

True

The unique identifier of the parent initiator group.

uuid

string

path

True

The unique identifier of the nested initiator group.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

igroup

igroup

name

string

The name of the initiator group.

records

array[records]

An array of initiator groups specified to add multiple nested initiator groups to an initiator group in a single API call. Not allowed when the name property is used.

uuid

string

The unique identifier of the initiator group.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "igroup": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "igroup1",
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

4

The nested initiator group is not a member of the initiator group.

5374852

The parent initiator group specified in the URI does not exist.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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

Name Type Description

_links

_links

uuid

string

The unique identifier of the parent initiator group.

records

Name Type Description

_links

_links

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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