Delete Guest Processes
Terminates a process in the guest OS. On Posix guests, the process is sent a SIGTERM signal. If that doesn’t terminate the process, a SIGKILL signal is sent. A process may still be running if it’s stuck.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/processes/{pid}?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
pid
Required
Process ID of the process to be terminated
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
VmGuestProcessesDeleteRequestBody 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.not_allowed_in_current_state : if the virtual machine vm is not running. | com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware tools in the guest OS. if the operation is disabled by the VMware tools in the guest OS.
403
com.vmware.vapi.std.errors.unauthorized : if credentials does not have permission to terminate the process.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine vm is not found. if the pid is not found. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the Processes.ProcessErrorDetails 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"
$VmGuestProcessesDeleteRequestBody = Initialize-VmGuestProcessesDeleteRequestBody -Credentials $VmGuestCredentials
Invoke-DeleteVmPidProcesses -Vm "MyVm" -Pid 789 -VmGuestProcessesDeleteRequestBody $VmGuestProcessesDeleteRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestProcessesDeleteRequestBody = Initialize-VmGuestProcessesDeleteRequestBody -Credentials $VmGuestCredentials
Invoke-DeleteVmPidProcesses -Vm "MyVm" -Pid 789 -VmGuestProcessesDeleteRequestBody $VmGuestProcessesDeleteRequestBody
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/processes/{pid}?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
On This Page
Guest Processes Operations
post
post
