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

Add nested initiator groups to an initiator group

PDFs

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

Introduced In: 9.9

Adds one or more nested initiator groups to an initiator group. A single nested initiator group can be added by directly specifying the name or UUID. Multiple nested initiator groups can be added by specifying the names or UUIDs in the records array. Nested initiator groups cannot be added to an initiator group that already directly contains initiators.

Required properties

  • name and/or uuid or records - Nested initiator groups to add to the initiator group.

  • lun igroup add

Learn more

Parameters

Name Type In Required Description

igroup.uuid

string

path

True

The unique identifier of the parent initiator group.

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

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 request 
{
  "igroup": {
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "igroup1",
  "records": [
    {
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 201, Created
Name Type Description

num_records

integer

The number of records in the response.

records

array[igroup_nested]
Example response 
{
  "num_records": 1,
  "records": [
    {
      "igroup": {
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "name": "igroup1",
      "records": [
        {
          "name": "igroup1",
          "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374735

An attempt was made to add a child igroup that would exceed the maximum allowable depth.

5374736

A supplied child initiator group already exists in the parent initiator group's hierarchy.

5374737

A supplied child initiator group already exists in another initiator group's hierarchy.

5374739

A supplied child initiator group has an operating system type that differs from the parent initiator group.

5374740

A supplied child initiator group has an protocol that differs from the parent initiator group.

5374741

A supplied child initiator group is already owned by a different child in the initiator group's hierarchy.

5374742

A supplied child initiator group contains an initiator that is already owned by another initiator group in the hierarchy.

5374764

An unreplicated initiator group cannot be added as a child of a replicated initiator group.

5374852

The initiator group specified in the URI does not exist.

5374878

The supplied child initiator group does not exist.

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

igroup

Name Type Description

uuid

string

The unique identifier of the parent initiator group.

records

Name Type Description

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

igroup_nested

Name Type Description

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.

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.