Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiators From Target

Removes iSCSI initiator or initiator groups from one target.
If the specified target cannot be found or if the initiators or initiator groups specified by the initiatorNames cannot be associated with the specified target, a VsanFault will be raised.

Some unhealthy status of the vSAN iSCSI service can also lead to this VsanFault exception, e.g., the unavailability of the home object.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanIscsiTargetSystem/{moId}/VsanVitRemoveIscsiInitiatorsFromTarget

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanIscsiTargetSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body

VsanVitRemoveIscsiInitiatorsFromTargetRequestType of type(s) application/json

Required

"VsanVitRemoveIscsiInitiatorsFromTargetRequestType Object"

cluster

Required

: reference to cluster resource.

Required privileges: Host.Inventory.EditCluster

string

targetAlias

Required

: target alias.

array of string

initiatorNames

Required

: initiator or initiator group name list.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

Failure

Returns VsanFault of type(s) application/json

"VsanFault Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanIscsiTargetSystem/{moId}/VsanVitRemoveIscsiInitiatorsFromTarget

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

V San Service Api Operations