Get Guest Processes
Returns the status of a process running in the guest operating system, including those started by Processes.create that may have recently completed.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/processes/{pid}?action=get
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
Specifies the process to query.
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
VmGuestProcessesGetRequestBody 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.
Response
Response
Response BodyResponse Body
200 OK returns
VmGuestProcessesInfo
of type application/json
The #Info for the process with id pid.
{
"command": "string",
"exit_code": 0,
"finished": "string",
"name": "string",
"owner": "string",
"started": "string"
}
string
command
Required
The full command line of the process.
string
name
Required
The process name.
string
owner
Required
The process owner.
string
started
Required
The start time of the process.
integer
exit_code
Optional
If the process was started using Processes.create then the process exit code will be available if queried within 5 minutes after it completes. Set if the process was started with Processes.create and has recently exited.
string
finished
Optional
If the process was started using Processes.create then the process completion time will be available if queried within 5 minutes after it completes. Set if the process was started with Processes.create and has recently exited.
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.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine vm is not found. if the process 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"
$VmGuestProcessesGetRequestBody = Initialize-VmGuestProcessesGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmPidProcesses -Vm "MyVm" -Pid 789 -VmGuestProcessesGetRequestBody $VmGuestProcessesGetRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestProcessesGetRequestBody = Initialize-VmGuestProcessesGetRequestBody -Credentials $VmGuestCredentials
Invoke-GetVmPidProcesses -Vm "MyVm" -Pid 789 -VmGuestProcessesGetRequestBody $VmGuestProcessesGetRequestBody
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=get
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.0
On This Page
Guest Processes Operations
post
post
