Host Vsan System Remove Disk Mapping Task

Host Vsan System Remove Disk Mapping Task

Delete given set of disk mappings from use by the VSAN service on this host.

This API may be used to remove all disks in a given mapping, including its ssd. This operation is only permitted if the VSAN service on this host is not configured to automatically claim storage.

The task is cancellable.

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

See also RemoveDisk_Task, UpdateVsan_Task, autoClaimStorage.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/HostVsanSystem/{moId}/RemoveDiskMapping_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 9.0.0.0 APIs.

Request Body
RemoveDiskMappingRequestType of type(s) application/json
Required 
"RemoveDiskMappingRequestType Object"
array of object
mapping
Required

list of disk mappings to be removed from VSAN usage.

maintenanceSpec
Optional

Any additional actions to move data out of the disk before removing it. See HostMaintenanceSpec. If unspecified, there is no action taken to move data from the disk.

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

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/HostVsanSystem/{moId}/RemoveDiskMapping_Task
On This Page
V San Service Api 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