Guest File Manager Delete File In Guest

Guest File Manager Delete File In Guest

Deletes a file in the guest OS

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

string
release
Required

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

Request Body
DeleteFileInGuestRequestType of type(s) application/json
Required 
"DeleteFileInGuestRequestType Object"
object
vm
Required

Reference to an instance of the VirtualMachine managed object.

object
auth
Required

GuestAuthentication is an abstract base class for authentication in the guest.

string
filePath
Required

The complete path to the file or symbolic link to be deleted.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

GuestOperationsFault: if there is an error processing a guest operation.

GuestOperationsUnavailable: if the VM agent for guest operations is not running.

InvalidPowerState: if the VM is not powered on.

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

TaskInProgress: if the virtual machine is busy.

GuestPermissionDenied: if the operation fails because the guest authentication will not allow the operation.

InvalidGuestLogin: if the the guest authentication information was not accepted.

NotAFile: if the specified object is not a file.

FileFault: if there is a file error in the guest operating system.

GuestComponentsOutOfDate: if the guest agent is too old to support the operation.

OperationNotSupportedByGuest: if the operation is not supported by the guest OS.

OperationDisabledByGuest: if the operation is not enabled due to guest agent configuration.

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}/GuestFileManager/{moId}/DeleteFileInGuest
On This Page
Guest File Manager Operations
POST
Guest File Manager Change File Attributes In Guest
POST
Guest File Manager Create Temporary Directory In Guest
POST
Guest File Manager Create Temporary File In Guest
POST
Guest File Manager Delete Directory In Guest
POST
Guest File Manager Delete File In Guest
POST
Guest File Manager Initiate File Transfer From Guest
POST
Guest File Manager Initiate File Transfer To Guest
POST
Guest File Manager List Files In Guest
POST
Guest File Manager Make Directory In Guest
POST
Guest File Manager Move Directory In Guest
POST
Guest File Manager Move File In Guest