Host Vsan System Add Disks Task

Host Vsan System Add Disks Task

Add the set of given disks for use by the VSAN service on this host.

Users may use this API to manually add disks for use by VSAN, without specifying an explicit VsanHostDiskMapping, when the VSAN service not configured to automatically claim storage. Any ineligible disk in the set of given disks and disks which would have exceeded the capacity will be ignored and will not be published in returned result.

Mount a VsanHostDiskMapping if the specified disk belongs to the unmounted mapping and is of type ssd.

Upon successful completion of the returned Task, its result field will be populated with a VsanHostDiskMapResult[] and caller must inspect VsanHostDiskMapResult[] to check result for individual VsanHostDiskMapping.

See also QueryDisksForVsan, autoClaimStorage, mounted.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostVsanSystem/{moId}/AddDisks_Task
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
AddDisksRequestType of type(s) application/json
Required
{
    "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"
        }
    ]
}
disk
Required

list of disks to add for use by the VSAN service

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}