Skip to main content

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.

proximity

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

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"
        }
      }
    ],
    "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",
  "proximity": {
    "peer_svms": [
      {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "peer1",
        "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
      }
    ]
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "name": "iqn.1998-01.com.corp.iscsi:name1",
      "proximity": {
        "peer_svms": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "peer1",
            "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
          }
        ]
      }
    }
  ]
}

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"
            }
          }
        ],
        "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",
      "proximity": {
        "peer_svms": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "peer1",
            "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
          }
        ]
      },
      "records": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "comment": "string",
          "name": "iqn.1998-01.com.corp.iscsi:name1",
          "proximity": {
            "peer_svms": [
              {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "name": "peer1",
                "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
              }
            ]
          }
        }
      ]
    }
  ]
}

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.

5373982

An invalid WWN was specified. The length is incorrect.

5373983

An invalid WWN was specified. The format is incorrect.

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.

5374761

An error was reported by the peer cluster while adding an initiator to a replicated initiator group. The specific error will be included as a nested error.

5374852

The initiator group specified in the URI does not exist.

5374917

Duplicated initiators have conflicting property values.

5375055

The local_svm property of an initiator proximity was not specified.

5375056

An SVM peering relationship that does not have the initiator group's SVM as the local SVM was specified.

5375261

Setting initiator proximity is not supported for the SVM type.

5376057

Setting initiator proximity is not supported for the ONTAP version.

5376059

Setting initiator proximity to a peer that is either the destination of an SVM DR relationship or in a Metrocluster configuration is not supported.

26345672

The specified SVM peering relationship was not found.

26345673

An SVM peering relationship between the initiator group's SVM and specified peer SVM was not found.

26345675

An SVM peering relationship UUID and name were specified and they do not refer to the same SVM peering relationship.

26345680

Supplied SVM peer is on the local cluster. The operation requires a peer on a remote cluster.

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

Name Type Description

error

returned_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

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

A network interface. Either UUID or name may be supplied on input.

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

A network interface. Either UUID or name may be supplied on input.

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.

peer_svms

A reference to an SVM peer relationship.

Name Type Description

_links

_links

name

string

The local name of the peer SVM. This name is unique among all local and peer SVMs.

uuid

string

The unique identifier of the SVM peer relationship. This is the UUID of the relationship, not the UUID of the peer SVM itself.

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

Name Type Description

local_svm

boolean

A boolean that indicates if the initiator is proximal to the SVM of the containing initiator group. This is required for any POST or PATCH that includes the proximity sub-object.

peer_svms

array[peer_svms]

An array of remote peer SVMs to which the initiator is proximal.

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.

proximity

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

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.

proximity

proximity

Properties that define to what SVMs the initiator is proximal. This information is used to properly report active optimized and active non-optimized network paths via ALUA. If no configuration has been specified for an initiator, the sub-object will not be present in GET.

These properties can be set via initiator group POST and PATCH and apply to all instances of the initiator in all initiator groups in the SVM and its peers. The proximity sub-object for an initiator is set in POST and PATCH in its entirety and replaces any previously set proximity for the initiator within the SVM for the initiator within the SVM. The local_svm property must always be set to true or false when setting the proximity property. To clear any previously set proximity, POST or PATCH the proximity object to null.

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

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.