Vsan Iscsi Target System Vsan Vit Get Iscsi Targets

Gets iSCSI target 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}/VsanVitGetIscsiTargets

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

VsanVitGetIscsiTargetsRequestType 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 target list, it may be empty.

[
    {
        "_typeName": "string",
        "alias": "string",
        "iqn": "string",
        "authSpec": {
            "_typeName": "string",
            "authType": "string",
            "userNameAttachToTarget": "string",
            "userSecretAttachToTarget": "string",
            "userNameAttachToInitiator": "string",
            "userSecretAttachToInitiator": "string"
        },
        "port": 0,
        "networkInterface": "string",
        "affinityLocation": "string",
        "lunCount": 0,
        "objectInformation": {
            "_typeName": "string",
            "directoryName": "string",
            "vsanObjectUuid": "string",
            "vsanHealth": "string",
            "policyAttributes": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": "string"
                }
            ],
            "spbmProfileUuid": "string",
            "spbmProfileGenerationId": "string",
            "spbmComplianceResult": {
                "_typeName": "string",
                "checkTime": "string",
                "profile": "string",
                "objectUUID": "string",
                "complianceStatus": "string",
                "mismatch": false,
                "violatedPolicies": [
                    {
                        "_typeName": "string",
                        "id": "string",
                        "expectedValue": "string",
                        "currentValue": "string"
                    }
                ],
                "operationalStatus": {
                    "_typeName": "string",
                    "healthy": false,
                    "operationETA": "string",
                    "operationProgress": 0,
                    "transitional": false
                },
                "objPolicyGenerationId": "string"
            }
        },
        "ioOwnerHost": "string",
        "initiators": [
            "string"
        ],
        "initiatorGroups": [
            "string"
        ]
    }
]

array of object

Optional

Defines iSCSI Target, which is a storage resource located on iSCSI target service.

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Iscsi Target System Vsan Vit Add Iscsi Initiator Group