Skip to main content

Delete an initiator group

Contributors
PDFs

DELETE /protocols/san/igroups/{uuid}

Introduced In: 9.6

Deletes an initiator group.

  • lun igroup delete

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the initiator group.

allow_delete_while_mapped

boolean

query

False

Allows the deletion of a mapped initiator group.

Deleting a mapped initiator group means that the LUNs, to which the initiator group is mapped, are no longer available to the initiators. 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.

5374760

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

5374852

The initiator group 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.