Vsan Iscsi Target System Vsan Vit Get Iscsi Initiator Groups

Gets iSCSI initiator group list for one cluster. If the operation fails, a VsanFault will be raised.

Gets iSCSI initiator group list for one cluster.
If the operation fails, a VsanFault will be raised.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanIscsiTargetSystem/{moId}/VsanVitGetIscsiInitiatorGroups

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.1.0.0 APIs.

Request Body

VsanVitGetIscsiInitiatorGroupsRequestType of type(s) application/json

Required

Show optional properties

{
    "cluster": {}
}

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

cluster

Required

: reference to cluster resource.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

iSCSI initiator group list.

[
    {
        "_typeName": "string",
        "name": "string",
        "initiators": [
            "string"
        ],
        "targets": [
            {
                "_typeName": "string",
                "alias": "string",
                "iqn": "string"
            }
        ]
    }
]

array of object

Optional

Defines the initiator group, which serves as a container to contain a initiator name list.

If user add one initiator group to one target, it means all initiators in it can access this target.
An initiator functions as an iSCSI client. An initiator negotiates with a target to establish connectivity to a LUN and it treats iSCSI LUNs the same way as they would a raw SCSI or IDE hard drive.

500

Failure

Returns VsanFault of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations