Host Vsan System Remove Disk Task

Host Vsan System Remove Disk Task

Remove the set of given disks from use by the VSAN service on this host.

Users may use this API to manually remove a nonSsd from a VsanHostDiskMapping. This operation is only permitted if the VSAN service on this host is not configured to automatically claim storage.

The task is cancellable.

This method may not be used to remove the last nonSsd from any given VsanHostDiskMapping. Removal of the last nonSsd can be accomplished by using RemoveDiskMapping_Task.

Upon successful completion of the returned Task, its result field will be populated with a VsanHostDiskResult[]. Sets DiskIsLastRemainingNonSSD fault in returned task if specified disk is the last nonSsd member of VsanHostDiskMapping.

See also RemoveDiskMapping_Task, UpdateVsan_Task, autoClaimStorage.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostVsanSystem/{moId}/RemoveDisk_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
RemoveDiskRequestType 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"
        }
    ],
    "maintenanceSpec": {
        "_typeName": "string",
        "vsanMode": {
            "_typeName": "string",
            "objectAction": "string"
        },
        "purpose": "string"
    },
    "timeout": 0
}
disk
Required

list of disks to be removed from use by the VSAN service.

maintenanceSpec
Optional

The HostMaintenanceSpec data object may be used to specify actions to be taken by a host upon entering maintenance mode.

If the HostMaintenanceSpec or any of its fields are omitted in a call to EnterMaintenanceMode_Task, default actions will be chosen as documented for each field's type.

See also EnterMaintenanceMode_Task, VsanHostDecommissionMode.

integer As int32 As int32
timeout
Optional

Time to wait for the task to complete in seconds. If the value is less than or equal to zero, there is no timeout. The operation fails with a Timedout exception if it timed out.

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"
}