Vsan Object System Vsan Delete Objects Task

Vsan Object System Vsan Delete Objects Task

Delete vSAN Objects on vSAN cluster.

When the 'cluster' parameter is specified, this is a cluster level asynchronous API. The delete operation will return a task result which tracks progress, please check the task state when use. When it's called against host, it's a host level asynchronous API, which deprecates the 'DeleteVsanObjects' in HostVsanInternalSystem. WARNING: This API can be slow because we do IOs to all the objects. This API can be used to delete vSAN objects. vSAN won't allow access to objects which have lost quorum. Such objects can be deleted with the optional "force" flag.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/VsanDeleteObjects_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 VsanObjectSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
VsanDeleteObjectsRequestType of type(s) application/json
Required 
"VsanDeleteObjectsRequestType Object"
cluster
Optional

vSAN cluster. Ignored if called against host.

Required privileges: Host.Config.Storage

array of string
objUuids
Required

The vSAN object UUIDs to delete.

boolean
force
Optional

The force flag, inaccessible objects can't be deleted without this flag. WARNING: it's at your own risk.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

500

Failure

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0 
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/VsanDeleteObjects_Task
On This Page
V San Service Api Operations
POST
Vsan Object System Vsan Delete Objects Task
POST
Vsan Object System Vsan Query Inaccessible Vm Swap Objects
POST
Vsan Object System Vsan Query Object Identities
POST
Vsan Object System Query Syncing Vsan Objects Summary
POST
Vsan Object System Vos Query Vsan Object Information
POST
Vsan Object System Relayout Objects
POST
Vsan Object System Vos Set Vsan Object Policy