Scripting Object - VcVirtualMachinePauseManager

Scripting-object corresponding to
VirtualMachinePauseManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

PauseManager is the singleton managed object that provides APIs that perform pause related operations on a virtual machine. Pausing a virtual machine causes the following to happen: 1. Device I/O shall get flushed for devices that support this. 2. The virtual CPU is stopped from executing further instructions. 3. Any operation that requires guest/tools interaction (including soft power operations) may timeout, depending on the pause duration. 4. Any other operations (including hard power operations) shall be allowed on the virtual machine. Pause/Unpause operations are only associated with a virtual machine in the powered on state. Any change to power on state (such as suspend, reset, power off) shall clear the pause. Also, pause state does not persist in snapshots.

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, pause, powerOnPaused_Task, unpause

_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

unpause

Unpause a virtual machine. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
None

powerOnPaused_Task

Powers on this virtual machine and pauses it right after. If the virtual machine is suspended, this method resumes execution from the suspend point once the pause has been cleared. Caller needs to have both "VirtualMachine.Interact.PowerOn" and "VirtualMachine.Interact.Pause" privileges on the virtual machine. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcHostSystem


Return Value

Type Description
VcTask

pause

Pause a virtual machine. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
None