Host Vsan System Query Disks For Vsan

Queries disks on this host for suitability to use with the VSAN service, and returns the result.

See also canonicalName.

Required privileges: System.Read

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostVsanSystem/{moId}/QueryDisksForVsan

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 HostVsanSystem/{moId}.

string

release

Required

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

Request Body

QueryDisksForVsanRequestType of type(s) application/json

Required

{
    "canonicalName": [
        "string"
    ]
}

array of string

canonicalName

Optional

may be set to restrict the query to the list of HostScsiDisk objects named by the given paths

Authentication

This operation uses the following authentication methods.

Session

Responses

200

a list of populated VsanHostDiskResult entries

Returns Array of VsanHostDiskResult of type(s) application/json

[
    {
        "_typeName": "string",
        "disk": {
            "_typeName": "string",
            "deviceName": "string",
            "deviceType": "string",
            "key": "string",
            "uuid": "string",
            "descriptor": [
                {
                    "_typeName": "string",
                    "quality": "string",
                    "id": "string"
                }
            ],
            "canonicalName": "string",
            "displayName": "string",
            "lunType": "string",
            "vendor": "string",
            "model": "string",
            "revision": "string",
            "scsiLevel": 0,
            "serialNumber": "string",
            "durableName": {
                "_typeName": "string",
                "namespace": "string",
                "namespaceId": 0,
                "data": [
                    0
                ]
            },
            "alternateName": [
                {
                    "_typeName": "string",
                    "namespace": "string",
                    "namespaceId": 0,
                    "data": [
                        0
                    ]
                }
            ],
            "standardInquiry": [
                0
            ],
            "queueDepth": 0,
            "operationalState": [
                "string"
            ],
            "capabilities": {
                "_typeName": "string",
                "updateDisplayNameSupported": false
            },
            "vStorageSupport": "string",
            "protocolEndpoint": false,
            "perenniallyReserved": false,
            "clusteredVmdkSupported": false,
            "applicationProtocol": "string",
            "dispersedNs": false,
            "capacity": {
                "_typeName": "string",
                "blockSize": 0,
                "block": 0
            },
            "devicePath": "string",
            "ssd": false,
            "localDisk": false,
            "physicalLocation": [
                "string"
            ],
            "emulatedDIXDIFEnabled": false,
            "vsanDiskInfo": {
                "_typeName": "string",
                "vsanUuid": "string",
                "formatVersion": 0
            },
            "scsiDiskType": "string"
        },
        "state": "string",
        "vsanUuid": "string",
        "error": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        },
        "degraded": false
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Host Vsan System Operations

POST

Host Vsan System Add Disks Task

POST