Guest Process Manager Terminate Process In Guest

Guest Process Manager Terminate Process In Guest

Terminates a process in the guest OS.

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

Request Body
TerminateProcessInGuestRequestType of type(s) application/json
Required 
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "pid": 0
}
MoRefVirtualMachine
vm
Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication
auth
Required

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

integer As int64 As int64
pid
Required

Process ID of the process to be terminated

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

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.

GuestProcessNotFound: if the pid does not refer to a valid process.

TaskInProgress: if the virtual machine is busy.

GuestPermissionDenied: if the process cannot be terminated because the guest authentication will not allow the operation.

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"
        }
    ]
}

On This Page
Guest Process Manager Operations
POST
Guest Process Manager List Processes In Guest
POST
Guest Process Manager Read Environment Variable In Guest
POST
Guest Process Manager Start Program In Guest
POST
Guest Process Manager Terminate Process In Guest