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

Introduced In: 9.6

Adds one or more initiators to an initiator group. This API does not support adding initiators to an initiator group that already contains nested initiator groups.

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

igroup.uuid

string

path

True

The unique identifier of the 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

_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-14T05:19:00Z"
          }
        ],
        "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: 201, Created
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

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

Headers

Name Description Type

Location

Useful for tracking the resource location

string

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.

5374917

Multiple matching initiators have been supplied with conflicting comments.
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.

_links

Name Type Description

next

href

self

href

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.