Host Storage System Query Available Ssds

Query the list SSD disks that can be used to contain a VFFS volume.

If the optional parameter name is supplied, queries for the SSD disks that can be used to contain extents of the specified VFFS volume. Otherwise, the method retrieves the SSD disks that can be used to contain the new VFFS volume.

This operation will filter out SSD disks that are currently in use by an existing VFFS volume.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostStorageSystem/{moId}/QueryAvailableSsds

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

string

release

Required

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

Request Body

QueryAvailableSsdsRequestType of type(s) application/json

Required

{
    "vffsPath": "string"
}

string

vffsPath

Optional

The path of the VFFS to extend. See FileSystemMountInfo.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array of data objects descrbing SSD disks.

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

[
    {
        "_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,
        "deviceReservation": "string",
        "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",
        "usedByMemoryTiering": false
    }
]

500

NotFound: if the named VFFS volume is not found.

InvalidArgument: if named VFFS volume is not a VFFS volume

HostConfigFault: if unable to query disk information.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations