Update an initiator
Suggest changes
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.
Related ONTAP commands
-
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 |
|---|---|---|
comment |
string |
A comment available for use by the administrator. Valid in POST and PATCH. |
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. |
|
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 |
Example request
{
"comment": "string",
"igroup": {
"name": "igroup1",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"records": [
{
"comment": "string"
}
]
}Response
Status: 200, OkError
Status: DefaultONTAP 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. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
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 |
|---|---|---|
name |
string |
The name of the initiator group. |
uuid |
string |
The unique identifier of the initiator group. |
records
| Name | Type | Description |
|---|---|---|
comment |
string |
A comment available for use by the administrator. Valid in POST and PATCH. |
igroup_initiator
| Name | Type | Description |
|---|---|---|
comment |
string |
A comment available for use by the administrator. Valid in POST and PATCH. |
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. |
|
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 |
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. |