# 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
--- | --- | ---
capability | VirtualMachineCapability |
config* | VirtualMachineConfigInfo |
datastore* P | ManagedObjectReference[] to a Datastore[] |
environmentBrowser | ManagedObjectReference to a EnvironmentBrowser |
guest* | GuestInfo |
guestHeartbeatStatus | ManagedEntityStatus |
layout* | VirtualMachineFileLayout |
layoutEx* | VirtualMachineFileLayoutEx | Since vSphere API 4.0
network* P | ManagedObjectReference[] 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
runtime | VirtualMachineRuntimeInfo |
snapshot* | VirtualMachineSnapshotInfo |
storage* | VirtualMachineStorageInfo | Since vSphere API 4.0
summary | VirtualMachineSummary |
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 present P 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
VirtualMachineMksTicket |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
ticketType P | xsd:string | Since vSphere API 4.1

P Required privilege: ticketType

Return Value

Type | Description
--- | ---
VirtualMachineTicket |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
questionId P | xsd:string | Since null
answerChoice P | xsd:string | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
ConcurrentAccess |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
mask* P | HostFeatureMask[] | Since vSphere API 6.7
completeMasks* P | xsd:boolean | Since vSphere API 6.7

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
diskId P | ID | Since vSphere API 6.5
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 6.5
controllerKey* P | xsd:int | Since vSphere API 6.5
unitNumber* P | xsd:int | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
DeviceUnsupportedForVmVersion |
FileFault |
InvalidController |
InvalidDatastore |
InvalidState |
MissingController |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | CustomizationSpec | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
CustomizationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
folder P | ManagedObjectReference to a Folder | Since null
name P | xsd:string | Since null
spec P | VirtualMachineCloneSpec | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
CustomizationFault |
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidState |
MigrationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
host* P | ManagedObjectReference 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 6.0
spec* P | FaultToleranceConfigSpec | Since vSphere API 6.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InsufficientResourcesFault |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
name P | xsd:string | Since null
description* P | xsd:string | Since null
memory P | xsd:boolean | Since null
quiesce P | xsd:boolean | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidName |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
name P | xsd:string | Since vSphere API 6.5
description* P | xsd:string | Since vSphere API 6.5
memory P | xsd:boolean | Since vSphere API 6.5
quiesceSpec* P | VirtualMachineGuestQuiesceSpec | Since vSphere API 6.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidName |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
NotSupported |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | CustomizationSpec | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
CustomizationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
FileFault |
InvalidPowerState |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
diskId P | ID | Since vSphere API 6.5

P Required privilege: diskId

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidState |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
vm P | ManagedObjectReference to a VirtualMachine | Since vSphere API 4.0

P Required privilege: vm

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
listOfConnections* P | VirtualMachineConnection[] | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
vm P | ManagedObjectReference to a VirtualMachine | Since vSphere API 4.0
host* P | ManagedObjectReference to a HostSystem | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | VirtualMachineInstantCloneSpec | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
vm P | ManagedObjectReference to a VirtualMachine | Since vSphere API 4.0

P Required privilege: vm

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
FileFault |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
pool P | ManagedObjectReference to a ResourcePool | Since null
host* P | ManagedObjectReference to a HostSystem | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastore |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
pool* P | ManagedObjectReference to a ResourcePool | Since null
host* P | ManagedObjectReference to a HostSystem | Since null
priority P | VirtualMachineMovePriority | Since null
state* P | VirtualMachinePowerState | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InsufficientResourcesFault |
InvalidState |
MigrationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
host* P | ManagedObjectReference 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
unlink P | xsd:boolean | Since vSphere API 4.0
disks* P | VirtualDisk[] | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidPowerState |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | UsbScanCodeSpec | Since vSphere API 6.5

P Required privilege: spec

Return Value

Type | Description
--- | ---
xsd:int |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
snapshot* P | ManagedObjectReference to a VirtualMachineSnapshot | Since vSphere API 4.0
deviceKey P | xsd:int | Since vSphere API 4.0
startOffset P | xsd:long | Since vSphere API 4.0
changeId P | xsd:string | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
DiskChangeInfo |

Faults

Type | Description
--- | ---
FileFault |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
VirtualMachineConnection[] |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
MethodFault[] |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
forLegacyFt* P | xsd:boolean | Since vSphere API 6.0

*Need not be set P Required privilege: forLegacyFt

Return Value

Type | Description
--- | ---
MethodFault[] |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string[] |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | VirtualMachineConfigSpec | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
ConcurrentAccess |
DuplicateName |
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidName |
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
configurationPath P | xsd: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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
spec P | VirtualMachineRelocateSpec | Since null
priority* P | VirtualMachineMovePriority | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
InsufficientResourcesFault |
InvalidDatastore |
InvalidState |
MigrationFault |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
consolidate* P | xsd:boolean | Since null

*Need not be set P Required privilege: consolidate

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
host* P | ManagedObjectReference to a HostSystem | Since null
suppressPowerOn* P | xsd:boolean | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InsufficientResourcesFault |
InvalidState |
NotFound |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
displays P | VirtualMachineDisplayTopology[] | Since vSphere API 4.0

P Required privilege: displays

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
width P | xsd:int | Since null
height P | xsd:int | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
name P | xsd:string | Since vSphere API 4.0
description* P | xsd:string | Since vSphere API 4.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
FileFault |
HostIncompatibleForRecordReplay |
InvalidName |
InvalidPowerState |
InvalidState |
RecordReplayDisabled |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
replaySnapshot P | ManagedObjectReference 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
vm* P | ManagedObjectReference 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 |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidPowerState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
installerOptions* P | xsd:string | Since null

*Need not be set P Required privilege: installerOptions

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

Type | Description
--- | ---
InvalidState |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call.
version* P | xsd: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 |
RuntimeFault | Thrown 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