List Guest Processes
List the processes running in the guest operating system, plus those started by Processes.create that 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?action=list
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.
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
VmGuestProcessesListRequestBody 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
array of
VmGuestProcessesSummary
of type application/json
The list of running processes is returned in an array of #Summary structures.
[
{
"command": "string",
"name": "string",
"owner": "string",
"pid": 0,
"started": "string"
}
]
string
command
Required
The full command line of the process.
string
name
Required
The process name.
string
owner
Required
The process owner.
integer
pid
Required
The process ID.
string
started
Required
The start time of the process.
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.
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"
$VmGuestProcessesListRequestBody = Initialize-VmGuestProcessesListRequestBody -Credentials $VmGuestCredentials
Invoke-ListVmGuestProcesses -Vm "MyVm" -VmGuestProcessesListRequestBody $VmGuestProcessesListRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestProcessesListRequestBody = Initialize-VmGuestProcessesListRequestBody -Credentials $VmGuestCredentials
Invoke-ListVmGuestProcesses -Vm "MyVm" -VmGuestProcessesListRequestBody $VmGuestProcessesListRequestBody
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?action=list
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.2.0
On This Page
Guest Processes Operations
post
post
