igroup

Contributors

igroup-add

POST /api/protocols/san/igroups/{igroup.uuid}/initiators

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

force

No REST Equivalent

This parameter is obsolete in ONTAPI and is ignored.

initiator

name

initiator-group-name

igroup.uuid

In the REST API, the initiator group is identified by "igroup.uuid"
in the endpoint path.

igroup-bind-portset

PATCH /api/protocols/san/igroups/{uuid}

Note: In the REST API, binding a portset to an initiator group is equivalent
to PATCHing the initiator group’s "portset.name" or
"portset.uuid" property to the name or UUID of
an existing portset in the same SVM.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in
the endpoint path.

portset-name

portset.name

igroup-create

POST /api/protocols/san/igroups

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

bind-portset

portset.name

initiator-group-name

name

initiator-group-type

protocol

os-type

os_type

ostype

os_type

igroup-destroy

DELETE /api/protocols/san/igroups/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

force

allow_delete_while_mapped

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in
the endpoint path.

igroup-disable-aix-support

Note: This API is obsolete. It was valid only for a prior ONTAP version
upgrade/revert.

This ONTAPI call does not have an equivalent REST API call.

igroup-get-iter

GET /api/protocols/san/igroups

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

initiator-group-alua-enabled

No REST Equivalent

This attribute is obsolete. It is always "true" in ONTAP.

initiator-group-delete-on-unmap

delete_on_unmap

initiator-group-name

name

initiator-group-os-type

os_type

initiator-group-portset-name

portset.name

initiator-group-report-scsi-name-enabled

No REST Equivalent

This API is obsolete and no longer implemented in ONTAP.

initiator-group-throttle-borrow

No REST Equivalent

This attribute is obsolete. It is always "false" in ONTAP.

initiator-group-throttle-reserve

No REST Equivalent

This attribute is obsolete. It is always "0" in ONTAP.

initiator-group-type

protocol

initiator-group-use-partner

No REST Equivalent

This attribute is obsolete. It is always "true" in ONTAP.

initiator-group-uuid

uuid

initiator-group-vsa-enabled

No REST Equivalent

This attribute is obsolete. It is always "false" in ONTAP.

initiators

initiators.name

lun-id

No REST Equivalent

This attribute is not used in the initiator group context
in ONTAPI. The logical unit identifier can be obtained by using the
GET /api/protocols/san/lun-maps endpoint.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

igroup-lookup-lun

GET /api/protocols/san/lun-maps

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

initiator-group-name

igroup.name

lun-id

lun.uuid

igroup-os-type-list

This ONTAPI call does not have an equivalent REST API call.

igroup-remove

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

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

force

allow_delete_while_mapped

initiator

name

initiator-group-name

igroup.uuid

In the REST API, the initiator group is identified by "igroup.uuid" in
the endpoint path.

igroup-rename

PATCH /api/protocols/san/igroups/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the
endpoint path.

initiator-group-new-name

name

igroup-set-attribute

PATCH /api/protocols/san/igroups/{uuid}

Note: This is equivalent to changing property "os_type" in the
PATCH /api/protocols/san/igroups/{uuid} endpoint.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

attribute

No REST Equivalent

force

No REST Equivalent

initiator-group-name

No REST Equivalent

In the REST API, the initiator group is identified by "uuid" in the endpoint
path.

value

os_type

igroup-unbind-portset

PATCH /api/protocols/san/igroups/{uuid}

Note: In the REST API, unbinding a portset from an initiator group is equivalent
to PATCHing the initiator group’s "portset.name" property to an
empty string ("").

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the endpoint
path.