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.

connectivity_tracking

connectivity_tracking

Overview of the initiator's connections to ONTAP.

  • readOnly: 1

  • Introduced in: 9.11

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",
  "connectivity_tracking": {
    "alerts": [
      {
        "summary": {
          "arguments": [
            {
              "code": "string",
              "message": "string"
            }
          ],
          "code": "4",
          "message": "entry doesn't exist",
          "target": "uuid"
        }
      }
    ],
    "connection_state": "string",
    "connections": [
      {
        "logins": [
          {
            "interface": {
              "fc": {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "name": "fc_lif1",
                "uuid": "3a09ab42-4da1-32cf-9d35-3385a6101a0b",
                "wwpn": "20:00:00:50:56:b4:13:a8"
              },
              "ip": {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "ip": {
                  "address": "10.10.10.7"
                },
                "name": "lif1",
                "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
              }
            },
            "last_seen_time": "2021-03-14 00:19:00 -0500"
          }
        ],
        "node": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      }
    ]
  },
  "igroup": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "igroup1",
    "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

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

summary

A user friendly message describing the connection state.

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.

alerts

Name Type Description

summary

summary

A user friendly message describing the connection state.

fc

An FC interface.

Name Type Description

_links

_links

name

string

The name of the FC interface.

uuid

string

The unique identifier of the FC interface.

wwpn

string

The WWPN of the FC interface.

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

ip

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

interface

Name Type Description

fc

fc

An FC interface.

ip

ip

logins

Name Type Description

connected

boolean

True if the initiator is currently logged in to this connection's interface.

interface

interface

last_seen_time

string

The last time this initiator logged in. Logins not seen for 48 hours are cleared and not reported.

node

Name Type Description

_links

_links

name

string

uuid

string

connections

Name Type Description

logins

array[logins]

node

node

connectivity_tracking

Overview of the initiator's connections to ONTAP.

Name Type Description

alerts

array[alerts]

connection_state

string

Connection state.

connections

array[connections]

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

name

string

The name of the initiator group.

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.

connectivity_tracking

connectivity_tracking

Overview of the initiator's connections to ONTAP.

  • readOnly: 1

  • Introduced in: 9.11

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

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.