Host Vsan System Unmount Disk Mapping Task

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.

See also RemoveDiskMapping_Task, AddDisks_Task, InitializeDisks_Task.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{api_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 
"UnmountDiskMappingRequestType Object"
array of object
mapping
Required

A VsanHostDiskMapping is a set of one SSD HostScsiDisk backed by a set of one or more non-SSD HostScsiDisk.

The maximum allowed VsanHostDiskMapping for a host is 5. A maximum set of 7 non-SSDs HostScsiDisk can be added to the one SSD HostScsiDisk.

See also VsanHostConfigInfoStorageInfo, InitializeDisks_Task.

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 
"MoRefTask Object"

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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostVsanSystem/{moId}/UnmountDiskMapping_Task
On This Page
Host Vsan System Operations
POST
Host Vsan System Add Disks Task
POST
Host Vsan System Evacuate Vsan Node Task
POST
Host Vsan System Initialize Disks Task
POST
Host Vsan System Query Disks For Vsan
POST
Host Vsan System Query Host Status
POST
Host Vsan System Recommission Vsan Node Task
POST
Host Vsan System Remove Disk Task
POST
Host Vsan System Remove Disk Mapping Task
POST
Host Vsan System Unmount Disk Mapping Task
POST
Host Vsan System Update Vsan Task
GET
Host Vsan System Get Config