Skip to main content

Remove a nested initiator group from an initiator group

Contributors
PDFs

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

Introduced In: 9.9

Removes a nested initiator group from an initiator group. This API does not delete the nested initiator group itself. It removes the relationship between a parent and child initiator group.

This API only supports removal of initiator groups owned directly by the initiator group. Further nested initiator groups must be removed from the direct parent initiator group.

  • lun igroup remove

Learn more

Parameters

Name Type In Required Description

igroup.uuid

string

path

True

The unique identifier of the parent initiator group.

uuid

string

path

True

The unique identifier of the nested initiator group.

allow_delete_while_mapped

boolean

query

False

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

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

5374738

The child initiator group is not owned by the parent initiator group.

5374743

LUN maps exist for a parent 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.