Managed Object - VirtualMachine

Property of
ApplyStorageRecommendationResult, AutoStartPowerInfo, CannotChangeDrsBehaviorForFtSecondary, CannotChangeHaSettingsForFtSecondary, CannotComputeFTCompatibleHosts, CannotPowerOffVmInCluster, CheckResult, ClusterAffinityRuleSpec, ClusterAntiAffinityRuleSpec, ClusterAttemptedVmInfo, ClusterDasFailoverLevelAdvancedRuntimeInfoVmSlots, ClusterDasVmConfigInfo, ClusterDrsFaultsFaultsByVm, ClusterDrsMigration, ClusterDrsVmConfigInfo, ClusterNotAttemptedVmInfo, ClusterPreemptibleVmPairInfo, ClusterVmGroup, ClusterVmOrchestrationInfo, ConverterAgentInternalManagedVmSpec, ConverterComputerSpecManagedVmLocation, CryptoManagerKmipCryptoKeyStatus, Datastore, DVSSummary, DvsVnicAllocatedResource, FailToLockFaultToleranceVMs, FaultsByVM, FaultToleranceCannotEditMem, FaultTolerancePrimaryConfigInfo, FaultTolerancePrimaryPowerOnNotAttempted, FaultToleranceSecondaryConfigInfo, FaultToleranceSecondaryOpResult, FaultToleranceVmNotDasProtected, FeatureRequirementsNotMet, HbrManagerVmReplicationCapability, HostAssignableHardwareBinding, HostGraphicsInfo, HostPlacedVirtualNicIdentifier, HostSystem, HostVmciAccessManagerAccessSpec, InvalidDasRestartPriorityForFtVm, InvalidDrsBehaviorForFtVm, InvalidVmState, MountError, Network, NoHostSuitableForFtSecondary, NotSupportedDeviceForFT, PlacementAction, PlacementAffinityRule, PlacementSpec, PowerOnFtSecondaryFailed, PowerOnFtSecondaryTimedout, ReplicationDiskConfigFault, ReplicationVmConfigFault, ReplicationVmFault, ResourcePool, SourceNodeSpec, StorageDrsVmConfigInfo, StorageMigrationAction, StoragePlacementAction, StoragePlacementSpec, VirtualDiskId, VirtualMachineDiskDeviceInfo, VirtualMachineSnapshot, VirtualMachineSnapshotTree, VirtualMachineSummary, VmAlreadyExistsInDatacenter, VmEventArgument, VmWwnConflict
Parameter to
AbortCustomization_Task, AcquireCredentialsInGuest, AddGuestAlias, ChangeFileAttributesInGuest, CheckClone_Task, CheckCompatibility_Task, CheckInstantClone_Task, CheckMigrate_Task, CheckPowerOn_Task, CheckRelocate_Task, CheckVmConfig_Task, CreateRegistryKeyInGuest, CreateTemporaryDirectoryInGuest, CreateTemporaryFileInGuest, CustomizeGuest_Task, DeleteDirectoryInGuest, DeleteFileInGuest, DeleteRegistryKeyInGuest, DeleteRegistryValueInGuest, DisableSecondaryVM_Task, EnableSecondaryVM_Task, FindRulesForVm, InitiateFileTransferFromGuest, InitiateFileTransferToGuest, ListFilesInGuest, ListGuestAliases, ListGuestMappedAliases, ListProcessesInGuest, ListRegistryKeysInGuest, ListRegistryValuesInGuest, LookupVmOverheadMemory, MakeDirectoryInGuest, MakePrimaryVM_Task, MoveDirectoryInGuest, MoveFileInGuest, PowerOnMultiVM_Task, QueryVMotionCompatibility, QueryVMotionCompatibilityEx_Task, ReadEnvironmentVariableInGuest, RecommendHostsForVm, ReleaseCredentialsInGuest, RemoveGuestAlias, RemoveGuestAliasByCert, SetRegistryValueInGuest, StartGuestNetwork_Task, StartProgramInGuest, TerminateFaultTolerantVM_Task, TerminateProcessInGuest, ValidateCredentialsInGuest, ValidateMigration
Returned by
CloneVM_Task, CreateChildVM_Task, CreateVM_Task, FindByDatastorePath, InstantClone_Task, RegisterChildVM_Task, RegisterVM_Task
Extends
ManagedEntity
See also
CustomizationSpec, Datastore, DiskChangeInfo, EnvironmentBrowser, FaultToleranceConfigSpec, FaultToleranceSecondaryOpResult, Folder, GuestInfo, HostFeatureMask, HostSystem, HttpNfcLease, ID, ManagedEntity, ManagedEntityStatus, MethodFault, Network, ResourceConfigSpec, ResourcePool, StorageRequirement, UsbScanCodeSpec, VirtualDisk, VirtualMachineCapability, VirtualMachineCloneSpec, VirtualMachineConfigInfo, VirtualMachineConfigSpec, VirtualMachineConnection, VirtualMachineDisplayTopology, VirtualMachineFileLayout, VirtualMachineFileLayoutEx, VirtualMachineGuestQuiesceSpec, VirtualMachineInstantCloneSpec, VirtualMachineMksTicket, VirtualMachineMovePriority, VirtualMachinePowerState, VirtualMachineRelocateSpec, VirtualMachineRuntimeInfo, VirtualMachineSnapshot, VirtualMachineSnapshotInfo, VirtualMachineStorageInfo, VirtualMachineSummary, VirtualMachineTicket
Since
null


Managed Object Description

Properties

Name Type Description
capabilityVirtualMachineCapability


config*VirtualMachineConfigInfo


datastore* PManagedObjectReference[]
to a Datastore[]


environmentBrowserManagedObjectReference
to a EnvironmentBrowser


guest*GuestInfo


guestHeartbeatStatusManagedEntityStatus


layout*VirtualMachineFileLayout


layoutEx*VirtualMachineFileLayoutEx

Since vSphere API 4.0
network* PManagedObjectReference[]
to a Network[]


parentVApp*ManagedObjectReference
to a ManagedEntity

Since vSphere API 4.1
resourceConfig*ResourceConfigSpec


resourcePool*ManagedObjectReference
to a ResourcePool


rootSnapshot*ManagedObjectReference[]
to a VirtualMachineSnapshot[]

Since vSphere API 4.1
runtimeVirtualMachineRuntimeInfo


snapshot*VirtualMachineSnapshotInfo


storage*VirtualMachineStorageInfo

Since vSphere API 4.0
summaryVirtualMachineSummary


Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
AcquireMksTicket, AcquireTicket, AnswerVM, ApplyEvcModeVM_Task, AttachDisk_Task, CheckCustomizationSpec, CloneVM_Task, ConsolidateVMDisks_Task, CreateScreenshot_Task, CreateSecondaryVM_Task, CreateSecondaryVMEx_Task, CreateSnapshot_Task, CreateSnapshotEx_Task, CryptoUnlock_Task, CustomizeVM_Task, DefragmentAllDisks, DetachDisk_Task, DisableSecondaryVM_Task, DropConnections, EnableSecondaryVM_Task, EstimateStorageForConsolidateSnapshots_Task, ExportVm, ExtractOvfEnvironment, InstantClone_Task, MakePrimaryVM_Task, MarkAsTemplate, MarkAsVirtualMachine, MigrateVM_Task, MountToolsInstaller, PowerOffVM_Task, PowerOnVM_Task, PromoteDisks_Task, PutUsbScanCodes, QueryChangedDiskAreas, QueryConnections, QueryFaultToleranceCompatibility, QueryFaultToleranceCompatibilityEx, QueryUnownedFiles, RebootGuest, ReconfigVM_Task, RefreshStorageInfo, reloadVirtualMachineFromPath_Task, RelocateVM_Task, RemoveAllSnapshots_Task, ResetGuestInformation, ResetVM_Task, RevertToCurrentSnapshot_Task, SendNMI, SetDisplayTopology, SetScreenResolution, ShutdownGuest, StandbyGuest, StartRecording_Task, StartReplaying_Task, StopRecording_Task, StopReplaying_Task, SuspendVM_Task, TerminateFaultTolerantVM_Task, TerminateVM, TurnOffFaultToleranceForVM_Task, UnmountToolsInstaller, UnregisterVM, UpgradeTools_Task, UpgradeVM_Task
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AcquireMksTicket

Deprecated.

Required Privileges
VirtualMachine.Interact.ConsoleInteract

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
VirtualMachineMksTicket

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AcquireTicket

Required Privileges
None
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
ticketType Pxsd:string

Since vSphere API 4.1
P Required privilege: ticketType

Return Value

Type Description
VirtualMachineTicket

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AnswerVM

Required Privileges
VirtualMachine.Interact.AnswerQuestion

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
questionId Pxsd:string

Since null
answerChoice Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
ConcurrentAccess
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ApplyEvcModeVM_Task

Required Privileges
VirtualMachine.Config.Settings
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
mask* PHostFeatureMask[]

Since vSphere API 6.7
completeMasks* Pxsd:boolean

Since vSphere API 6.7
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AttachDisk_Task

Required Privileges
VirtualMachine.Config.AddExistingDisk
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
diskId PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
controllerKey* Pxsd:int

Since vSphere API 6.5
unitNumber* Pxsd:int

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DeviceUnsupportedForVmVersion
FileFault
InvalidController
InvalidDatastore
InvalidState
MissingController
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



CheckCustomizationSpec

Required Privileges
VirtualMachine.Provisioning.Customize

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PCustomizationSpec

Since null
P Required privilege: spec

Return Value

Type Description
None

Faults

Type Description
CustomizationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CloneVM_Task

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
folder PManagedObjectReference
to a Folder

Since null
name Pxsd:string

Since null
spec PVirtualMachineCloneSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
CustomizationFault
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidState
MigrationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



ConsolidateVMDisks_Task

Required Privileges
VirtualMachine.State.RemoveSnapshot
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



CreateScreenshot_Task

Required Privileges
VirtualMachine.Interact.CreateScreenshot
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



CreateSecondaryVM_Task

Deprecated.

Required Privileges
VirtualMachine.Interact.CreateSecondary
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
*Need not be set P Required privilege: host

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault
VmFaultToleranceIssue

Events

Type
None



CreateSecondaryVMEx_Task

Required Privileges
VirtualMachine.Interact.CreateSecondary
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since vSphere API 6.0
spec* PFaultToleranceConfigSpec

Since vSphere API 6.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault
VmFaultToleranceIssue

Events

Type
None



CreateSnapshot_Task

Deprecated.

Required Privileges
VirtualMachine.State.CreateSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
name Pxsd:string

Since null
description* Pxsd:string

Since null
memory Pxsd:boolean

Since null
quiesce Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress
VmConfigFault

Events

Type
None



CreateSnapshotEx_Task

Required Privileges
VirtualMachine.State.CreateSnapshot
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
name Pxsd:string

Since vSphere API 6.5
description* Pxsd:string

Since vSphere API 6.5
memory Pxsd:boolean

Since vSphere API 6.5
quiesceSpec* PVirtualMachineGuestQuiesceSpec

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress
VmConfigFault

Events

Type
None



CryptoUnlock_Task

Required Privileges
Cryptographer.RegisterVM
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
NotSupported
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CustomizeVM_Task

Required Privileges
VirtualMachine.Provisioning.Customize

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PCustomizationSpec

Since null
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
CustomizationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DefragmentAllDisks

Required Privileges
VirtualMachine.Interact.DefragmentAllDisks
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



DetachDisk_Task

Required Privileges
VirtualMachine.Config.RemoveDisk
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
diskId PID

Since vSphere API 6.5
P Required privilege: diskId

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidState
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



DisableSecondaryVM_Task

Required Privileges
VirtualMachine.Interact.DisableSecondary
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 4.0
P Required privilege: vm

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmFaultToleranceIssue

Events

Type
None



DropConnections

Required Privileges
VirtualMachine.Interact.ConsoleInteract
Since
vSphere API 7.0.1.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
listOfConnections* PVirtualMachineConnection[]

Since vSphere API 7.0.1.0
*Need not be set P Required privilege: listOfConnections

Return Value

Type Description
xsd:boolean

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



EnableSecondaryVM_Task

Required Privileges
VirtualMachine.Interact.EnableSecondary
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 4.0
host* PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault
VmFaultToleranceIssue

Events

Type
None



EstimateStorageForConsolidateSnapshots_Task

Required Privileges
VirtualMachine.State.RemoveSnapshot
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



ExportVm

Required Privileges
VApp.Export
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a HttpNfcLease

Faults

Type Description
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



ExtractOvfEnvironment

Required Privileges
VApp.ExtractOvfEnvironment
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
xsd:string

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



InstantClone_Task

Required Privileges
VirtualMachine.Provisioning.Clone
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PVirtualMachineInstantCloneSpec

Since vSphere API 6.7
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
DisallowedMigrationDeviceAttached
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



MakePrimaryVM_Task

Required Privileges
VirtualMachine.Interact.MakePrimary
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 4.0
P Required privilege: vm

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmFaultToleranceIssue

Events

Type
None



MarkAsTemplate

Required Privileges
VirtualMachine.Provisioning.MarkAsTemplate

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
FileFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



MarkAsVirtualMachine

Required Privileges
VirtualMachine.Provisioning.MarkAsVM

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
pool PManagedObjectReference
to a ResourcePool

Since null
host* PManagedObjectReference
to a HostSystem

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



MigrateVM_Task

Deprecated.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
pool* PManagedObjectReference
to a ResourcePool

Since null
host* PManagedObjectReference
to a HostSystem

Since null
priority PVirtualMachineMovePriority

Since null
state* PVirtualMachinePowerState

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
MigrationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout
VmConfigFault

Events

Type
None



MountToolsInstaller

Required Privileges
VirtualMachine.Interact.ToolsInstall

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault
VmToolsUpgradeFault

Events

Type
None



PowerOffVM_Task

Required Privileges
VirtualMachine.Interact.PowerOff

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



PowerOnVM_Task

Required Privileges
VirtualMachine.Interact.PowerOn

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
*Need not be set P Required privilege: host

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



PromoteDisks_Task

Required Privileges
VirtualMachine.Provisioning.PromoteDisks
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
unlink Pxsd:boolean

Since vSphere API 4.0
disks* PVirtualDisk[]

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



PutUsbScanCodes

Required Privileges
VirtualMachine.Interact.PutUsbScanCodes
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PUsbScanCodeSpec

Since vSphere API 6.5
P Required privilege: spec

Return Value

Type Description
xsd:int

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryChangedDiskAreas

Required Privileges
VirtualMachine.Provisioning.DiskRandomRead
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
snapshot* PManagedObjectReference
to a VirtualMachineSnapshot

Since vSphere API 4.0
deviceKey Pxsd:int

Since vSphere API 4.0
startOffset Pxsd:long

Since vSphere API 4.0
changeId Pxsd:string

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
DiskChangeInfo

Faults

Type Description
FileFault
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryConnections

Required Privileges
VirtualMachine.Interact.ConsoleInteract
Since
vSphere API 7.0.1.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
VirtualMachineConnection[]

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout
VmConfigFault

Events

Type
None



QueryFaultToleranceCompatibility

Deprecated.

Required Privileges
VirtualMachine.Config.QueryFTCompatibility
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
MethodFault[]

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



QueryFaultToleranceCompatibilityEx

Required Privileges
VirtualMachine.Config.QueryFTCompatibility
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
forLegacyFt* Pxsd:boolean

Since vSphere API 6.0
*Need not be set P Required privilege: forLegacyFt

Return Value

Type Description
MethodFault[]

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



QueryUnownedFiles

Required Privileges
VirtualMachine.Config.QueryUnownedFiles
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
xsd:string[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RebootGuest

Required Privileges
VirtualMachine.Interact.Reset

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
ToolsUnavailable

Events

Type
None



ReconfigVM_Task

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PVirtualMachineConfigSpec

Since null
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
ConcurrentAccess
DuplicateName
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



RefreshStorageInfo

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



reloadVirtualMachineFromPath_Task

Required Privileges
VirtualMachine.Config.ReloadFromPath
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
configurationPath Pxsd:string

Since vSphere API 4.1
P Required privilege: configurationPath

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
AlreadyExists
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None



RelocateVM_Task

Required Privileges
Resource.ColdMigrate

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
spec PVirtualMachineRelocateSpec

Since null
priority* PVirtualMachineMovePriority

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidDatastore
InvalidState
MigrationFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
Timedout
VmConfigFault

Events

Type
None



RemoveAllSnapshots_Task

Required Privileges
VirtualMachine.State.RemoveSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
consolidate* Pxsd:boolean

Since null
*Need not be set P Required privilege: consolidate

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress

Events

Type
None



ResetGuestInformation

Required Privileges
VirtualMachine.Config.ResetGuestInfo

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ResetVM_Task

Required Privileges
VirtualMachine.Interact.Reset

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



RevertToCurrentSnapshot_Task

Required Privileges
VirtualMachine.State.RevertToSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
suppressPowerOn* Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InsufficientResourcesFault
InvalidState
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress
VmConfigFault

Events

Type
None



SendNMI

Required Privileges
VirtualMachine.Interact.GuestControl
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



SetDisplayTopology

Required Privileges
VirtualMachine.Interact.ConsoleInteract
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
displays PVirtualMachineDisplayTopology[]

Since vSphere API 4.0
P Required privilege: displays

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ToolsUnavailable

Events

Type
None



SetScreenResolution

Required Privileges
VirtualMachine.Interact.ConsoleInteract

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
width Pxsd:int

Since null
height Pxsd:int

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ToolsUnavailable

Events

Type
None



ShutdownGuest

Required Privileges
VirtualMachine.Interact.PowerOff

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
ToolsUnavailable

Events

Type
None



StandbyGuest

Required Privileges
VirtualMachine.Interact.Suspend

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
ToolsUnavailable

Events

Type
None



StartRecording_Task

Deprecated.

Required Privileges
VirtualMachine.Interact.Record
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
name Pxsd:string

Since vSphere API 4.0
description* Pxsd:string

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
HostIncompatibleForRecordReplay
InvalidName
InvalidPowerState
InvalidState
RecordReplayDisabled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress
VmConfigFault

Events

Type
None



StartReplaying_Task

Deprecated.

Required Privileges
VirtualMachine.Interact.Replay
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
replaySnapshot PManagedObjectReference
to a VirtualMachineSnapshot

Since vSphere API 4.0
P Required privilege: replaySnapshot

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
HostIncompatibleForRecordReplay
InvalidPowerState
InvalidState
NotFound
RecordReplayDisabled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress
VmConfigFault

Events

Type
None



StopRecording_Task

Deprecated.

Required Privileges
VirtualMachine.Interact.Record
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress

Events

Type
None



StopReplaying_Task

Deprecated.

Required Privileges
VirtualMachine.Interact.Replay
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidPowerState
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SnapshotFault
TaskInProgress

Events

Type
None



SuspendVM_Task

Required Privileges
VirtualMachine.Interact.Suspend

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



TerminateFaultTolerantVM_Task

Required Privileges
VirtualMachine.Interact.TerminateFaultTolerantVM
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
vm* PManagedObjectReference
to a VirtualMachine

Since vSphere API 4.0
*Need not be set P Required privilege: vm

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmFaultToleranceIssue

Events

Type
None



TerminateVM

Required Privileges
VirtualMachine.Interact.PowerOff
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



TurnOffFaultToleranceForVM_Task

Required Privileges
VirtualMachine.Interact.TurnOffFaultTolerance
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmFaultToleranceIssue

Events

Type
None



UnmountToolsInstaller

Required Privileges
VirtualMachine.Interact.ToolsInstall

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VmConfigFault

Events

Type
None



UnregisterVM

Required Privileges
VirtualMachine.Inventory.Unregister

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidPowerState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



UpgradeTools_Task

Required Privileges
VirtualMachine.Interact.ToolsInstall

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
installerOptions* Pxsd:string

Since null
*Need not be set P Required privilege: installerOptions

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
ToolsUnavailable
VmConfigFault
VmToolsUpgradeFault

Events

Type
None



UpgradeVM_Task

Required Privileges
VirtualMachine.Config.UpgradeVirtualHardware

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachine used to make the method call.
version* Pxsd:string

Since null
*Need not be set P Required privilege: version

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
AlreadyUpgraded
InvalidState
NoDiskFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None