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.
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}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"auth": {
"_typeName": "string",
"interactiveSession": false
},
"spec": {
"_typeName": "string",
"programPath": "string",
"arguments": "string",
"workingDirectory": "string",
"envVariables": [
"string"
]
}
}
GuestAuthentication is an abstract base class for authentication in the guest.
The pid of the program started.
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}