Vsan Iscsi Target System Vsan Vit Edit Iscsi Target

Edits iSCSI target in this cluster.
All properties in VsanIscsiTargetSpec can be changed.

If authType changed, all existing connections are not effected, but the new connection to this target need to use the new authentication type, if port or network interface changed, it has the same impact to connection as authType change. If IQN or alias provided, it should be unique.
If IQN or alias is not unique, 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}/VsanVitEditIscsiTarget

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

VsanVitEditIscsiTargetRequestType of type(s) application/json

Required

"VsanVitEditIscsiTargetRequestType Object"

cluster

Required

: reference to cluster resource.

Required privileges: Host.Inventory.EditCluster

targetSpec

Required

: reference to iSCSI target specification.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The related task.

This response body class contains all of the following: MoRefTask

{
    "0": "M",
    "1": "o",
    "2": "R",
    "3": "e",
    "4": "f",
    "5": "T",
    "6": "a",
    "7": "s",
    "8": "k",
    "9": " ",
    "10": "O",
    "11": "b",
    "12": "j",
    "13": "e",
    "14": "c",
    "15": "t"
}

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}/VsanVitEditIscsiTarget

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations