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

Add initiators to an initiator group

Contributors
PDFs

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

Adds one or more initiators to an initiator group.

Required properties

  • name or records.name - Initiator name(s) to add to the initiator group.

  • lun igroup add

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

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

igroup.uuid

string

path

True

The unique identifier of the initiator group.

Request Body

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.

records

array[records]

An array of initiators specified to add multiple initiators to an initiator group in a single API call. Valid in POST only and not allowed when the name property is used.
Example request 
{
  "_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",
  "records": [
    {
      "_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"
    }
  ]
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[igroup_initiator]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_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",
      "records": [
        {
          "_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"
        }
      ]
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1254193

Adding an initiator would cause the initiator to be mapped to the same LUN more than once.

1254324

Adding an initiator would cause the initiator to have the same logical unit identifier for multiple LUN maps.

5373969

A supplied initiator name looks like an iSCSI IQN initiator, but the portions after the prefix are missing.

5373971

A supplied initiator name looks like an iSCSI IQN initiator, but the date portion is invalid.

5373972

A supplied initiator name looks like an iSCSI IQN initiator, but the naming authority portion is invalid.

5373977

A supplied initiator name looks like an iSCSI EUI initiator, but the length is invalid.

5373978

A supplied initiator name looks like an iSCSI EUI initiator, but the format is invalid.

5373992

A supplied initiator name was too long to be valid.

5373993

A supplied initiator name did not match any valid format.

5374033

Initiators must be supplied.

5374035

A supplied initiator is already in the initiator group.

5374038

An invalid Fibre Channel WWPN was supplied.

5374039

An invalid iSCSI initiator name was supplied.

5374734

An initiator is already in another initiator group with a conflicting operating system type.

5374852

The initiator group specified in the URI does not exist.

5374853

You can add initiators to an initiator group using the records property, or the name property, but you cannot use both in the same request.

5374854

Only records property elements should be populated with the name property values.
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.

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.

igroup_initiator

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.

records

array[records]

An array of initiators specified to add multiple initiators to an initiator group in a single API call. Valid in POST only and not allowed when the name property is used.

_links

Name Type Description

next

href

self

href

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.