Host Vsan System Unmount Disk Mapping Task

Unmount the mounted VsanHostDiskMapping.

An unmounted volume cannot be used for any VSAN operations. In contrast to RemoveDiskMapping_Task, this operation does not destroy or alter VSAN data on the disks. AddDisks_Task and InitializeDisks_Task can be used to re-mount the diskMapping.

In case of shared-SAS, where diskMappings are visible to more than one VSAN hosts, Users may use this API to manually unmount and re-mount diskMappings.

Upon successful completion of the returned Task, its result field will be populated with VsanHostDiskMapResult[]. If any errors are encountered, the returned field will instead contain populated error information.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostVsanSystem/{moId}/UnmountDiskMapping_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

UnmountDiskMappingRequestType of type(s) application/json

Required

{
    "mapping": [
        {
            "_typeName": "string",
            "ssd": {
                "_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"
            },
            "nonSsd": [
                {
                    "_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"
                }
            ]
        }
    ]
}

array of VsanHostDiskMapping

mapping

Required

mapping

Authentication

This operation uses the following authentication methods.

Session

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

500

InvalidState: If the VsanHostDiskMapping is already unmounted.

VsanFault: if operation fails with VSAN-specific error.

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

Host Vsan System Operations

POST

Host Vsan System Add Disks Task