Scripting Object - VcGuestProcessManager

Scripting-object corresponding to
GuestProcessManager
Attribute of
VcGuestOperationsManager

Scripting Object Description

ProcessManager is the managed object that provides APIs to manipulate the guest operating system processes.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, listProcessesInGuest, readEnvironmentVariableInGuest, startProgramInGuest, terminateProcessInGuest

startProgramInGuest

Starts a program in the guest operating system.

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

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2VcGuestProgramSpec


Return Value

Type Description
Number

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

listProcessesInGuest

List the processes running in the guest operating system, plus those started by {@link vim.vm.guest.ProcessManager#startProgram} that have recently completed.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2Number []


Return Value

Type Description
VcGuestProcessInfo []

readEnvironmentVariableInGuest

Reads an environment variable from the guest OS

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 system user.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String []


Return Value

Type Description
String []

terminateProcessInGuest

Terminates a process in the guest OS.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2Number


Return Value

Type Description
None