Guest Process Manager Start Program In Guest

Guest Process Manager Start Program In Guest

Starts a program in the guest operating system.

A process started this way can have its status queried with ListProcessesInGuest. When the process completes, its exit code and end time will be available for 5 minutes after completion.

If VMware Tools is restarted, the exit code and end time will not be available.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/GuestProcessManager/{moId}/StartProgramInGuest
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 9.0.0.0 APIs.

Request Body
StartProgramInGuestRequestType of type(s) application/json
Required 
"StartProgramInGuestRequestType Object"
vm
Required

Virtual machine to perform the operation on.

Required privileges: VirtualMachine.GuestOperations.Execute

auth
Required

The guest authentication data. See GuestAuthentication.

spec
Required

The arguments describing the program to be started.

Authentication
This operation uses the following authentication methods.
Responses
200

The pid of the program started.

Returns integer of type(s) application/json
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.

TaskInProgress: if the virtual machine is busy.

FileNotFound: if the program path does not exist.

FileFault: if there is a file error in the guest operating system.

CannotAccessFile: if the program path cannot be accessed.

GuestPermissionDenied: if the program path cannot be run 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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/GuestProcessManager/{moId}/StartProgramInGuest
On This Page
Virtual Infrastructure 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