File Manager Delete Datastore File Task

Deletes the specified file or folder from the datastore.

If a file of a virtual machine is deleted, it may corrupt that virtual machine. Folder deletes are always recursive. The datacenter parameter may be omitted if a URL is used to name the file or folder.

If the source is an extent of a virtual disk, this operation treats the extent as a file.

It is important to note that this operation will provide transactional guarantees only for a file. No guarantees are provided when deleting folders. If the intent is to delete a virtual machine registered in the inventory, please refer to Destroy_Task.

Requires Datastore.FileManagement privilege on the datastore.

Request

URI

POST

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

string

release

Required

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

Request Body

DeleteDatastoreFileRequestType of type(s) application/json

Required

{
    "name": "string",
    "datacenter": {
        "type": "string",
        "value": "string"
    }
}

string

name

Required

The name of the file or folder, either a URL or a datastore path referring to the file or folder to be deleted.

MoRefDatacenter

datacenter

Optional

Reference to an instance of the Datacenter managed 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

InvalidDatastore: if the operation cannot be performed on the datastore. Typically, a specific subclass of this exception is thrown.

FileNotFound: if the file or folder specified by name is not found.

CannotDeleteFile: if the delete operation on the file or folder fails.

FileLocked: if the source file or folder is currently locked or in use.

FileFault: if there is a generic file 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

File Manager Operations

POST

File Manager Change Owner