Update an initiator group

09/11/2024 Contributors

PDFs

PATCH /protocols/san/igroups/{uuid}

Introduced In: 9.6

Updates an initiator group.

lun igroup modify
lun igroup rename
lun igroup bind
lun igroup unbind

Learn more

DOC /protocols/san/igroups

Parameters

Name	Type	In	Required	Description
uuid	string	path	True	The unique identifier of the initiator group.

Name

Type

Required

Description

uuid

string

path

True

The unique identifier of the initiator group.

Request Body

Name Type Description

Name	Type	Description
_links	_links
comment	string	A comment available for use by the administrator. Valid in POST and PATCH.
connectivity_tracking	connectivity_tracking	An overview of the connections to ONTAP by the initiators in this group. readOnly: 1 Introduced in: 9.11
delete_on_unmap	boolean	An option that causes the initiator group to be deleted when the last LUN map associated with it is deleted. Optional in POST and PATCH. This property defaults to false when the initiator group is created.
igroups	array[igroup_child]	The initiator groups that are members of the group. Optional in POST. This property is mutually exclusive with the initiators property during POST. This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the `igroups` property of the child initiator group. Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregatation of all initiators in any nested initiator groups. After creation, nested initiator groups can be added or removed from the initiator group using the `/protocols/san/igroups/{igroup.uuid}/igroups` endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.
initiators	array[initiators]	The initiators that are members of the group or any group nested below this group. Optional in POST. This property is mutually exclusive with the igroups property during POST. During GET, this array contains initiators that are members of this group or any nested initiator groups below this group. When initiators of nested groups are returned, they include links to the initiator group that directly contains the initiator. Zero or more initiators can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the `/protocols/san/igroups/{igroup.uuid}/initiators` endpoint. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.
lun_maps	array[lun_maps]	All LUN maps with which the initiator is associated. If the requested igroup is part of a remote, non-local, MetroCluster SVM, the LUN maps are not retrieved. There is an added computational cost to retrieving property values for `lun_maps`. They are not populated for either a collection GET or an instance GET unless explicitly requested using the `fields` query parameter. See Requesting specific fields to learn more.
name	string	The name of the initiator group. Required in POST; optional in PATCH.
os_type	string	The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH.
parent_igroups	array[igroup_parent]	The initiator groups that contain this initiator group as a member.
portset	portset	The portset to which the initiator group is bound. Binding the initiator group to a portset restricts the initiators of the group to accessing mapped LUNs only through network interfaces in the portset. In a nested initiator group hierarchy, only a portset bound to the initiator group at the same level at which it is mapped, applies; portsets bound to parent or child initiator groups are ignored. Optional in POST and PATCH. To unbind a portset from the initiator group, PATCH the `portset` object to `null`, or PATCH `portset.name` to an empty string ("").
protocol	string	The protocols supported by the initiator group. This restricts the type of initiators that can be added to the initiator group. Optional in POST; if not supplied, this defaults to mixed. The protocol of an initiator group cannot be changed after creation of the group.
replication	replication	Properties related to initator group replication.
supports_igroups	boolean	An initiator group may contain either initiators or other initiator groups, but not both simultaneously. This property is true when initiator groups can be added to this initiator group. The `initiators.name` property cannot be used to determine this via a query because it reports initiators inherited from nested igroups.
svm	svm	SVM, applies only to SVM-scoped objects.
target	target	Properties of the SCSI target to which the initiator group provides access.
uuid	string	The unique identifier of the initiator group.

_links

comment

string

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

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

readOnly: 1
Introduced in: 9.11

delete_on_unmap

boolean

An option that causes the initiator group to be deleted when the last LUN map associated with it is deleted. Optional in POST and PATCH. This property defaults to false when the initiator group is created.

igroups

array[igroup_child]

The initiator groups that are members of the group. Optional in POST.

This property is mutually exclusive with the initiators property during POST.

This array contains only the direct children of the initiator group. If the member initiator groups have further nested initiator groups, those are reported in the igroups property of the child initiator group.

Zero or more nested initiator groups can be supplied when the initiator group is created. The initiator group will act as if it contains the aggregatation of all initiators in any nested initiator groups.

After creation, nested initiator groups can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/igroups endpoint. See link:post-protocols-san-igroups-igroups(#-san-igroup-nested-create)anddelete-protocols-san-igroups-igroups-.htmlPOST /protocols/san/igroups/{igroup.uuid}/igroups and [DELETE /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}] for more details.

initiators

array[initiators]

The initiators that are members of the group or any group nested below this group. Optional in POST.

This property is mutually exclusive with the igroups property during POST.

During GET, this array contains initiators that are members of this group or any nested initiator groups below this group. When initiators of nested groups are returned, they include links to the initiator group that directly contains the initiator.

Zero or more initiators can be supplied when the initiator group is created. After creation, initiators can be added or removed from the initiator group using the /protocols/san/igroups/{igroup.uuid}/initiators endpoint. See link:post-protocols-san-igroups-initiators(#-san-igroup-initiator-create)anddelete-protocols-san-igroups-initiators-.htmlPOST /protocols/san/igroups/{igroup.uuid}/initiators and [DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}] for more details.

lun_maps

array[lun_maps]

All LUN maps with which the initiator is associated.

If the requested igroup is part of a remote, non-local, MetroCluster SVM, the LUN maps are not retrieved.

There is an added computational cost to retrieving property values for lun_maps. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

name

string

The name of the initiator group. Required in POST; optional in PATCH.

os_type

string

The host operating system of the initiator group. All initiators in the group should be hosts of the same operating system. Required in POST; optional in PATCH.

parent_igroups

array[igroup_parent]

The initiator groups that contain this initiator group as a member.

portset

The portset to which the initiator group is bound. Binding the initiator group to a portset restricts the initiators of the group to accessing mapped LUNs only through network interfaces in the portset.

In a nested initiator group hierarchy, only a portset bound to the initiator group at the same level at which it is mapped, applies; portsets bound to parent or child initiator groups are ignored.

Optional in POST and PATCH. To unbind a portset from the initiator group, PATCH the portset object to null, or PATCH portset.name to an empty string ("").

protocol

string

The protocols supported by the initiator group. This restricts the type of initiators that can be added to the initiator group. Optional in POST; if not supplied, this defaults to mixed.

The protocol of an initiator group cannot be changed after creation of the group.

replication

Properties related to initator group replication.

supports_igroups

boolean

An initiator group may contain either initiators or other initiator groups, but not both simultaneously. This property is true when initiator groups can be added to this initiator group. The initiators.name property cannot be used to determine this via a query because it reports initiators inherited from nested igroups.

svm

SVM, applies only to SVM-scoped objects.

target

Properties of the SCSI target to which the initiator group provides access.

uuid

string

The unique identifier of the initiator group.

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",
    "required_nodes": [
      {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    ]
  },
  "igroups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "igroups": [
        null
      ],
      "name": "igroup1",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "initiators": [
    {
      "_links": {
        "connectivity_tracking": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "connectivity_tracking": {
        "connection_state": "string"
      },
      "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"
          }
        ]
      }
    }
  ],
  "lun_maps": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "logical_unit_number": 0,
      "lun": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "lun1",
        "node": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "name": "igroup1",
  "os_type": "string",
  "parent_igroups": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "name": "igroup1",
      "parent_igroups": [
        null
      ],
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "portset": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "portset1",
    "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
  },
  "protocol": "string",
  "replication": {
    "error": {
      "igroup": {
        "name": "igroup1",
        "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
      },
      "summary": {
        "arguments": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "code": "4",
        "message": "entry doesn't exist"
      }
    },
    "peer_svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "peer1",
      "uuid": "4204cf77-4c82-9bdb-5644-b5a841c097a9"
    },
    "state": "string"
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "target": {
    "firmware_revision": "9111",
    "product_id": "LUN C-Mode",
    "vendor_id": "NETAPP"
  },
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
1254264	An attempt was made to bind a portset to an initiator group that is already bound to a portset.
5373958	An invalid initiator group name was supplied for a rename operation.
5374023	A rename operation failed because an initiator group with the same name already exists.
5374027	An attempt was made to bind a portset with no member network interfaces to the initiator group.
5374028	An attempt was made to bind a portset with an incompatible protocol to the initiator group.
5374733	An initiator is already in another initiator group with a conflicting operating system type.
5374745	An attempt was made to add an initiator group as a child to itself.
5374746	The cluster is currently running in a mixed version and nested initiator groups cannot be created until the effective cluster version reaches 9.9.1.
5374747	The cluster is currently running in a mixed version and initiator group comments cannot be created until the effective cluster version reaches 9.9.1.
5374749	An initiator group's replication peer SVM cannot be changed without first being cleared.
5374759	An error was reported by the peer cluster while modifying a replicated initiator group. The specific error will be included as a nested error.
5374763	An error was reported by the peer cluster while renaming a replicated initiator group. The specific error will be included as a nested error.
5374765	An initiator group cannot be replicated if it has unreplicated child initiatior groups.
5374766	A replicated initiator group cannot be changed to unreplicated if it is the child of a replicated initiatior group.
5374770	An unreplicated initiator group cannot be changed to replicated due to a conflict in its LUN maps.
5374852	The initiator group does not exist.
5374868	The initiator group was partially modified before an error was encountered while renaming the initiator group.
5375258	The igroup is already replicated to a different peer SVM.
5376253	Initiator group replication requires an effective cluster version of 9.15.1.
5376255	Initiator group replication requires the peer cluster to have an effective cluster version of 9.15.1.
6620376	SVM peering information is unavailable.
6620384	The supplied SVMs are not peered.

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

Name	Type	Description
error	returned_error

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

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

summary

A user friendly message describing the connection state of the initiator group.

Name	Type	Description
arguments	array[error_arguments]	Message arguments
code	string	Error code
message	string	Error message

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 of the initiator group.

Name

Type

Description

summary

A user friendly message describing the connection state of the initiator group.

required_nodes

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

connectivity_tracking

An overview of the connections to ONTAP by the initiators in this group.

Name	Type	Description
alerts	array[alerts]
connection_state	string	Connection state.
required_nodes	array[required_nodes]	Nodes to which the initiators in this group should be connected to ensure reliable service. This is the collection of any node hosting a LUN mapped to this igroup as well as the HA partners of those nodes.

Name

Type

Description

alerts

array[alerts]

connection_state

string

Connection state.

required_nodes

array[required_nodes]

Nodes to which the initiators in this group should be connected to ensure reliable service. This is the collection of any node hosting a LUN mapped to this igroup as well as the HA partners of those nodes.

igroup_child

Name	Type	Description
_links	_links
comment	string	A comment available for use by the administrator.
igroups	array[igroup_child]	Further nested initiator groups.
name	string	The name of the initiator group.
uuid	string	The unique identifier of the initiator group.

Name

Type

Description

_links

comment

string

A comment available for use by the administrator.

igroups

array[igroup_child]

Further nested initiator groups.

name

string

The name of the initiator group.

uuid

string

The unique identifier of the initiator group.

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

Name	Type	Description
href	string

Name

Type

Description

href

string

self

A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

Name	Type	Description
connectivity_tracking	connectivity_tracking	A link to the initiator with connectivity information relevant to its membership of this initiator group.
self	self	A link to the initiator where mutations can be made. If the initiator is inherited from a nested initiator group, the link refers to the initiator in the nested initiator group. In this case, mutations of the initiator will be applied to all initiator groups referencing the same nested initiator group.

Name

Type

Description

connectivity_tracking

A link to the initiator with connectivity information relevant to its membership of this initiator group.

self

connectivity_tracking

Overview of the initiator's connections to ONTAP.

Name	Type	Description
connection_state	string	Connection state.

Name

Type

Description

connection_state

string

Connection state.

igroup

The initiator group that directly owns the initiator, which is where modification of the initiator is supported. This property will only be populated when the initiator is a member of a nested initiator group.

Name

Update an initiator group

Creating your file...

Related ONTAP commands

Learn more

Parameters

Request Body

Response

Error

Definitions