Vslm V Storage Object Manager Vslm Delete V Storage Object Task

Delete a virtual storage object and its associated backings.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

VslmSyncFault will set in the task error if the delete of the FCD succeeded in the backend, however, there was a issue with syncing the datastore. The error can be ignored with the anticipation of Pandora resolving this automatically and the risk of Pandora DB having stale FCDs consequently affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs. Any subsequent operation on the FCD is guranteed to fail.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmDeleteVStorageObject_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 VslmVStorageObjectManager/{moId}.

string

release

Required

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

Request Body

VslmDeleteVStorageObjectRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {
        "id": "string"
    }
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    }
}

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

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

FileFault: If an error occurs when deleting the virtual storage object.

NotFound: If the specified virtual storage object cannot be found.

InvalidDatastore: If the operation cannot be performed on the datastore.

InvalidState: If the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted.

TaskInProgress: If the virtual storage object is busy.

VslmFault: If a VSLM internal server error occurred.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

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.

On This Page

Description

Request

Path Parameters