Delete Guest Filesystem Files
Deletes a file in the guest operating system
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files/{path}?action=delete
Path Parameters
Path Parameters
string
vm
Required
Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.
string
path
Required
The complete path to the file or symbolic link to be deleted.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmGuestFilesystemFilesDeleteRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"credentials": {
"interactive_session": false,
"type": "USERNAME_PASSWORD"
}
}
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if path is not a file. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. if path is too long. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not running. | com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware Tools in the guest operating system. if the operation is disabled by the VMware Tools in the guest operating system.
403
com.vmware.vapi.std.errors.unauthorized : if path cannot be accessed. if path cannot be deleted because the guest authentication will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if path is not found. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD"
$VmGuestFilesystemFilesDeleteRequestBody = Initialize-VmGuestFilesystemFilesDeleteRequestBody -Credentials $VmGuestCredentials
Invoke-DeleteVmPathFiles -Vm "MyVm" -Path "MyPath" -VmGuestFilesystemFilesDeleteRequestBody $VmGuestFilesystemFilesDeleteRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestFilesystemFilesDeleteRequestBody = Initialize-VmGuestFilesystemFilesDeleteRequestBody -Credentials $VmGuestCredentials
Invoke-DeleteVmPathFiles -Vm "MyVm" -Path "MyPath" -VmGuestFilesystemFilesDeleteRequestBody $VmGuestFilesystemFilesDeleteRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"credentials":{"interactive_session":false,"password":"string","saml_token":"string","type":"USERNAME_PASSWORD","user_name":"string"}}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files/{path}?action=delete
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 7.0.2.0
