Skip to main content
A newer release of this product is available.

Delete an initiator from an initiator group

Contributors
PDFs

DELETE /protocols/san/igroups/{igroup.uuid}/initiators/{name}

Introduced In: 9.6

Deletes an initiator from an initiator group.

This API only supports removal of initiators owned directly by the initiator group. Initiators of nested initiator groups must be removed on the initiator group that directly owns the initiator.

  • lun igroup remove

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 name of the initiator to delete.

allow_delete_while_mapped

boolean

query

False

Allows the deletion of an initiator from of a mapped initiator group.

Deleting an initiator from a mapped initiator group makes the LUNs to which the initiator group is mapped no longer available to the initiator. This might cause a disruption in the availability of data.

This parameter should be used with caution.

  • Default value:

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1254213

The initiator group is mapped to one or more LUNs and allow_delete_while_mapped has not been specified.

5374034

An initiator is not a member of the initiator group.

5374041

The initiator is not owned by the supplied initiator group.

5374852

The initiator group specified in the URI does not exist.

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

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.