Guest Process Manager List Processes In Guest

Guest Process Manager List Processes In Guest

List the processes running in the guest operating system, plus those started by StartProgramInGuest that have recently completed.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/GuestProcessManager/{moId}/ListProcessesInGuest
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 GuestProcessManager/{moId}.

string
release
Required

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


Request Body
ListProcessesInGuestRequestType of type(s) application/json
Required

Show optional properties

{
    "vm": {},
    "auth": {
        "interactiveSession": false
    }
}
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "pids": [
        0
    ]
}
vm
Required

Reference to an instance of the VirtualMachine managed object.

auth
Required

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

array of integer
pids
Optional

If set, only return information about the specified processes. Otherwise, information about all processes are returned. If a specified processes does not exist, nothing will be returned for that process.

Authentication
This operation uses the following authentication methods.
Responses
200

The list running processes is returned in an array of GuestProcessInfo structures.

Returns Array of GuestProcessInfo of type(s) application/json
[
    {
        "_typeName": "string",
        "name": "string",
        "pid": 0,
        "owner": "string",
        "cmdLine": "string",
        "startTime": "string",
        "endTime": "string",
        "exitCode": 0
    }
]

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 there are insufficient permissions in the guest OS.

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

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: MethodFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}