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

Update an initiator

Contributors
PDFs

PATCH /protocols/san/igroups/{igroup.uuid}/initiators/{name}

Introduced In: 9.9

Updates an initiator of an initiator group. This API only supports modification of initiators owned directly by the initiator group. Initiators of nested initiator groups must be modified on the initiator group that directly owns the initiator.

  • lun igroup initiator modify

Learn more

Parameters

Name Type In Required Description

igroup.uuid

string

path

True

The unique identifier of the initiator group.

name

string

path

True

The initiator name.

Request Body

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

records

array[records]

An array of initiators specified to add multiple initiators to an initiator group in a single API call. Not allowed when the name property is used.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "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"
        }
      },
      "comment": "string",
      "name": "iqn.1998-01.com.corp.iscsi:name1"
    }
  ]
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374034

An initiator is not a member of the initiator group.

5374744

The cluster is currently running in a mixed version and the initiators cannot be modified until the effective cluster version reaches 9.9.1.

5374852

The initiator group does not exist.

5374918

A subset of the provided list of initiators were modified before a failure occurred.
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

comment

string

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

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.

igroup_initiator

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

records

array[records]

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

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.