| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
ListProcessesInGuest, ReadEnvironmentVariableInGuest, StartProgramInGuest, TerminateProcessInGuest |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestProcessManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Virtual machine to perform the operation on.
Since vSphere API 5.0 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 5.0 |
pids* P | xsd:long[] |
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.
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
GuestProcessInfo[] | The list running processes is returned in an array of GuestProcessInfo structures. |
Faults
Type | Description |
---|---|
GuestComponentsOutOfDate | Thrown if the guest agent is too old to support the operation. |
GuestOperationsFault | Thrown if there is an error processing a guest operation. |
GuestOperationsUnavailable | Thrown if the VM agent for guest operations is not running. |
GuestPermissionDenied | Thrown if there are insufficient permissions in the guest OS. |
InvalidGuestLogin | Thrown if the the guest authentication information was not accepted. |
InvalidPowerState | Thrown if the VM is not powered on. |
InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. |
OperationDisabledByGuest | Thrown if the operation is not enabled due to guest agent configuration. |
OperationNotSupportedByGuest | Thrown if the operation is not supported by the guest OS. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual machine is busy. |
Events
Type | |
---|---|
None |
If the authentication uses interactiveSession, then the environment being read will be that of the user logged into the desktop. Otherwise it's the environment of the user specified by the auth.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestProcessManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Virtual machine to perform the operation on.
Since vSphere API 5.0 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 5.0 |
names* P | xsd:string[] |
The names of the variables to be read. If not set, then
all the environment variables are returned.
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
xsd:string[] | A string array containing the value of the variables, or all environment variables if nothing is specified. The format of each string is "name=value". If any specified environment variable isn't set, then nothing is returned for that variable. |
Faults
Type | Description |
---|---|
GuestComponentsOutOfDate | Thrown if the guest agent is too old to support the operation. |
GuestOperationsFault | Thrown if there is an error processing a guest operation. |
GuestOperationsUnavailable | Thrown if the VM agent for guest operations is not running. |
GuestPermissionDenied | Thrown if there are insufficient permissions in the guest OS. |
InvalidGuestLogin | Thrown if the the guest authentication information was not accepted. |
InvalidPowerState | Thrown if the VM is not powered on. |
InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. |
OperationDisabledByGuest | Thrown if the operation is not enabled due to guest agent configuration. |
OperationNotSupportedByGuest | Thrown if the operation is not supported by the guest OS. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual machine is busy. accepted by the guest OS. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestProcessManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Virtual machine to perform the operation on.
Since vSphere API 5.0 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 5.0 |
spec P | GuestProgramSpec |
The arguments describing the program to be started.
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
xsd:long | The pid of the program started. |
Faults
Type | Description |
---|---|
CannotAccessFile | Thrown if the program path cannot be accessed. |
FileFault | Thrown if there is a file error in the guest operating system. |
FileNotFound | Thrown if the program path does not exist. |
GuestComponentsOutOfDate | Thrown if the guest agent is too old to support the operation. |
GuestOperationsFault | Thrown if there is an error processing a guest operation. |
GuestOperationsUnavailable | Thrown if the VM agent for guest operations is not running. |
GuestPermissionDenied | Thrown if the program path cannot be run because the guest authentication will not allow the operation. |
InvalidGuestLogin | Thrown if the the guest authentication information was not accepted. |
InvalidPowerState | Thrown if the VM is not powered on. |
InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. |
OperationDisabledByGuest | Thrown if the operation is not enabled due to guest agent configuration. |
OperationNotSupportedByGuest | Thrown if the operation is not supported by the guest OS. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual machine is busy. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestProcessManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Virtual machine to perform the operation on.
Since vSphere API 5.0 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 5.0 |
pid P | xsd:long |
Process ID of the process to be terminated
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
GuestComponentsOutOfDate | Thrown if the guest agent is too old to support the operation. |
GuestOperationsFault | Thrown if there is an error processing a guest operation. |
GuestOperationsUnavailable | Thrown if the VM agent for guest operations is not running. |
GuestPermissionDenied | Thrown if the process cannot be terminated because the guest authentication will not allow the operation. |
GuestProcessNotFound | Thrown if the pid does not refer to a valid process. |
InvalidGuestLogin | Thrown if the the guest authentication information was not accepted. |
InvalidPowerState | Thrown if the VM is not powered on. |
InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. |
OperationDisabledByGuest | Thrown if the operation is not enabled due to guest agent configuration. |
OperationNotSupportedByGuest | Thrown if the operation is not supported by the guest OS. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual machine is busy. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |