Package com.vmware.vim25.mo

Class VirtualMachine

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.ExtensibleManagedObject

com.vmware.vim25.mo.ManagedEntity

com.vmware.vim25.mo.VirtualMachine

public class VirtualMachine
extends ManagedEntity

Constructor Summary

Constructors

Constructor	Description
VirtualMachine(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
VirtualMachineMksTicket	acquireMksTicket()	Deprecated. as of SDK4.1.
VirtualMachineTicket	acquireTicket(String ticketType)
void	answerVM(String questionId, String answerChoice)
Task	applyEvcModeVM_Task(HostFeatureMask[] mask, boolean completeMasks)
Task	attachDisk_Task(ID diskId, Datastore datastore, int controllerKey, int unitNumber)
void	checkCustomizationSpec(CustomizationSpec spec)
Task	cloneVM_Task(Folder folder, String name, VirtualMachineCloneSpec spec)
Task	consolidateVMDisks_Task()
Task	createScreenshot_Task()
Task	createSecondaryVM_Task(HostSystem host)
Task	createSecondaryVMEx_Task(FaultToleranceConfigSpec spec)
Task	createSecondaryVMEx_Task(HostSystem host)
Task	createSecondaryVMEx_Task(HostSystem host, FaultToleranceConfigSpec spec)
Task	createSnapshot_Task(String name, String description, boolean memory, boolean quiesce)
Task	createSnapshotEx_Task(String name, String description, boolean memory, VirtualMachineGuestQuiesceSpec quiesceSpec)
Task	cryptoUnlock_Task()
Task	customizeVM_Task(CustomizationSpec spec)
void	defragmentAllDisks()
Task	detachDisk_Task(ID diskId)
Task	disableSecondaryVM_Task(VirtualMachine vm)
boolean	dropConnections(VirtualMachineConnection[] listOfConnections)
Task	enableSecondaryVM_Task(VirtualMachine vm, HostSystem host)
Task	estimateStorageForConsolidateSnapshots_Task()
HttpNfcLease	exportVm()
String	extractOvfEnvironment()
VirtualMachineCapability	getCapability()
VirtualMachineConfigInfo	getConfig()
VirtualMachineSnapshot	getCurrentSnapShot()
Datastore[]	getDatastore()
Datastore[]	getDatastores()	Backward-compat alias for getDatastore().
EnvironmentBrowser	getEnvironmentBrowser()
GuestInfo	getGuest()
ManagedEntityStatus	getGuestHeartbeatStatus()
VirtualMachineFileLayout	getLayout()
VirtualMachineFileLayoutEx	getLayoutEx()
Network[]	getNetwork()
ManagedEntity	getParentVApp()
ResourceConfigSpec	getResourceConfig()
ResourcePool	getResourcePool()
VirtualMachineSnapshot[]	getRootSnapshot()
VirtualMachineRuntimeInfo	getRuntime()
VirtualMachineSnapshotInfo	getSnapshot()
VirtualMachineStorageInfo	getStorage()
VirtualMachineSummary	getSummary()
Task	instantClone_Task(VirtualMachineInstantCloneSpec spec)
Task	makePrimaryVM_Task(VirtualMachine vm)
void	markAsTemplate()
void	markAsVirtualMachine(ResourcePool pool, HostSystem host)
Task	migrateVM_Task(ResourcePool pool, HostSystem host, VirtualMachineMovePriority priority, VirtualMachinePowerState state)
void	mountToolsInstaller()
Task	powerOffVM_Task()
Task	powerOnVM_Task(HostSystem host)
Task	promoteDisks_Task(boolean unlink, VirtualDisk[] disks)
int	putUsbScanCodes(UsbScanCodeSpec spec)
DiskChangeInfo	queryChangedDiskAreas(VirtualMachineSnapshot snapshot, int deviceKey, long startOffset, String changeId)
VirtualMachineConnection[]	queryConnections()
LocalizedMethodFault[]	queryFaultToleranceCompatibility()	Deprecated. As of 6.0 use queryFaultToleranceCompatibilityEx(java.lang.Boolean)
LocalizedMethodFault[]	queryFaultToleranceCompatibilityEx()
LocalizedMethodFault[]	queryFaultToleranceCompatibilityEx(Boolean forLegacyFt)	This API can be invoked to determine whether a virtual machine is compatible for Fault Tolerance.
String[]	queryUnownedFiles()
void	rebootGuest()
Task	reconfigVM_Task(VirtualMachineConfigSpec spec)
void	refreshStorageInfo()
Task	reloadVirtualMachineFromPath_Task(String configurationPath)
Task	relocateVM_Task(VirtualMachineRelocateSpec spec)
Task	relocateVM_Task(VirtualMachineRelocateSpec spec, VirtualMachineMovePriority priority)
Task	removeAllSnapshots_Task()
Task	removeAllSnapshots_Task(boolean consolidate, SnapshotSelectionSpec spec)
void	resetGuestInformation()
Task	resetVM_Task()
Task	revertToCurrentSnapshot_Task(HostSystem host)
Task	revertToCurrentSnapshot_Task(HostSystem host, boolean suppressPowerOn)
void	sendNMI()
void	setDisplayTopology(VirtualMachineDisplayTopology[] displays)
void	setScreenResolution(int width, int height)
void	shutdownGuest()
void	standbyGuest()
Task	startRecording_Task(String name, String description)
Task	startReplaying_Task(VirtualMachineSnapshot replaySnapshot)
Task	stopRecording_Task()
Task	stopReplaying_Task()
Task	suspendVM_Task()
Task	terminateFaultTolerantVM_Task(VirtualMachine vm)
void	terminateVM()
Task	turnOffFaultToleranceForVM_Task()
void	unmountToolsInstaller()
void	unregisterVM()
Task	upgradeTools_Task(String installerOptions)
Task	upgradeVM_Task(String version)

Methods inherited from class com.vmware.vim25.mo.ManagedEntity

destroy_Task, getAlarmActionEabled, getConfigIssue, getConfigStatus, getCustomValue, getDeclaredAlarmState, getDisabledMethod, getEffectiveRole, getName, getOverallStatus, getParent, getPermission, getRecentTasks, getTag, getTriggeredAlarmState, reload, rename_Task

Methods inherited from class com.vmware.vim25.mo.ExtensibleManagedObject

getAvailableField, getValues, setCustomValue

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VirtualMachine

public VirtualMachine(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

getCapability

public VirtualMachineCapability getCapability()

getConfig

public VirtualMachineConfigInfo getConfig()

getDatastore

public Datastore[] getDatastore()

getEnvironmentBrowser

public EnvironmentBrowser getEnvironmentBrowser()

getGuest

public GuestInfo getGuest()

getGuestHeartbeatStatus

public ManagedEntityStatus getGuestHeartbeatStatus()

getLayout

public VirtualMachineFileLayout getLayout()

getLayoutEx

public VirtualMachineFileLayoutEx getLayoutEx()

getNetwork

public Network[] getNetwork()

getResourceConfig

public ResourceConfigSpec getResourceConfig()

getResourcePool

public ResourcePool getResourcePool()

getRuntime

public VirtualMachineRuntimeInfo getRuntime()

getSnapshot

public VirtualMachineSnapshotInfo getSnapshot()

getStorage

public VirtualMachineStorageInfo getStorage()

getSummary

public VirtualMachineSummary getSummary()

answerVM

public void answerVM(String questionId,
 String answerChoice)
              throws ConcurrentAccess,
RuntimeFault,
RemoteException

Throws:

ConcurrentAccess

RuntimeFault

RemoteException

applyEvcModeVM_Task

public Task applyEvcModeVM_Task(HostFeatureMask[] mask,
 boolean completeMasks)
                         throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

attachDisk_Task

public Task attachDisk_Task(ID diskId,
 Datastore datastore,
 int controllerKey,
 int unitNumber)
                     throws DeviceUnsupportedForVmVersion,
FileFault,
InvalidController,
InvalidDatastore,
InvalidState,
MissingController,
NotFound,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

DeviceUnsupportedForVmVersion

FileFault

InvalidController

InvalidDatastore

InvalidState

MissingController

NotFound

VmConfigFault

RuntimeFault

RemoteException

checkCustomizationSpec

public void checkCustomizationSpec(CustomizationSpec spec)
                            throws CustomizationFault,
RuntimeFault,
RemoteException

Throws:

CustomizationFault

RuntimeFault

RemoteException

consolidateVMDisks_Task

public Task consolidateVMDisks_Task()
                             throws FileFault,
InvalidState,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidState

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

createScreenshot_Task

public Task createScreenshot_Task()
                           throws FileFault,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidState

TaskInProgress

RuntimeFault

RemoteException

createSecondaryVM_Task

public Task createSecondaryVM_Task(HostSystem host)
                            throws FileFault,
InsufficientResourcesFault,
InvalidState,
TaskInProgress,
VmConfigFault,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

TaskInProgress

VmConfigFault

VmFaultToleranceIssue

RuntimeFault

RemoteException

createSecondaryVMEx_Task

public Task createSecondaryVMEx_Task(HostSystem host,
 FaultToleranceConfigSpec spec)
                              throws FileFault,
InsufficientResourcesFault,
InvalidState,
TaskInProgress,
VmConfigFault,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

TaskInProgress

VmConfigFault

VmFaultToleranceIssue

RuntimeFault

RemoteException

createSnapshot_Task

public Task createSnapshot_Task(String name,
 String description,
 boolean memory,
 boolean quiesce)
                         throws FileFault,
InvalidName,
InvalidState,
SnapshotFault,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidName

InvalidState

SnapshotFault

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

createSnapshotEx_Task

public Task createSnapshotEx_Task(String name,
 String description,
 boolean memory,
 VirtualMachineGuestQuiesceSpec quiesceSpec)
                           throws FileFault,
InvalidName,
InvalidState,
SnapshotFault,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidName

InvalidState

SnapshotFault

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

cryptoUnlock_Task

public Task cryptoUnlock_Task()
                       throws InvalidState,
NotSupported,
RuntimeFault,
RemoteException

Throws:

InvalidState

NotSupported

RuntimeFault

RemoteException

customizeVM_Task

public Task customizeVM_Task(CustomizationSpec spec)
                      throws CustomizationFault,
RuntimeFault,
RemoteException

Throws:

CustomizationFault

RuntimeFault

RemoteException

defragmentAllDisks

public void defragmentAllDisks()
                        throws FileFault,
InvalidPowerState,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidPowerState

InvalidState

TaskInProgress

RuntimeFault

RemoteException

detachDisk_Task

public Task detachDisk_Task(ID diskId)
                     throws FileFault,
InvalidState,
NotFound,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidState

NotFound

VmConfigFault

RuntimeFault

RemoteException

disableSecondaryVM_Task

public Task disableSecondaryVM_Task(VirtualMachine vm)
                             throws InvalidState,
TaskInProgress,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

VmFaultToleranceIssue

RuntimeFault

RemoteException

dropConnections

public boolean dropConnections(VirtualMachineConnection[] listOfConnections)
                        throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

enableSecondaryVM_Task

public Task enableSecondaryVM_Task(VirtualMachine vm,
 HostSystem host)
                            throws InvalidState,
TaskInProgress,
VmConfigFault,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

VmConfigFault

VmFaultToleranceIssue

RuntimeFault

RemoteException

estimateStorageForConsolidateSnapshots_Task

public Task estimateStorageForConsolidateSnapshots_Task()
                                                 throws FileFault,
InvalidState,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidState

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

exportVm

public HttpNfcLease exportVm()
                      throws FileFault,
InvalidPowerState,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidPowerState

InvalidState

TaskInProgress

RuntimeFault

RemoteException

instantClone_Task

public Task instantClone_Task(VirtualMachineInstantCloneSpec spec)
                       throws DisallowedMigrationDeviceAttached,
FileFault,
InsufficientResourcesFault,
InvalidDatastore,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

DisallowedMigrationDeviceAttached

FileFault

InsufficientResourcesFault

InvalidDatastore

InvalidState

TaskInProgress

RuntimeFault

RemoteException

makePrimaryVM_Task

public Task makePrimaryVM_Task(VirtualMachine vm)
                        throws InvalidState,
TaskInProgress,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

VmFaultToleranceIssue

RuntimeFault

RemoteException

markAsTemplate

public void markAsTemplate()
                    throws FileFault,
InvalidState,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidState

VmConfigFault

RuntimeFault

RemoteException

migrateVM_Task

public Task migrateVM_Task(ResourcePool pool,
 HostSystem host,
 VirtualMachineMovePriority priority,
 VirtualMachinePowerState state)
                    throws FileFault,
InsufficientResourcesFault,
InvalidState,
MigrationFault,
Timedout,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

MigrationFault

Timedout

VmConfigFault

RuntimeFault

RemoteException

mountToolsInstaller

public void mountToolsInstaller()
                         throws InvalidState,
VmConfigFault,
VmToolsUpgradeFault,
RuntimeFault,
RemoteException

Throws:

InvalidState

VmConfigFault

VmToolsUpgradeFault

RuntimeFault

RemoteException

powerOffVM_Task

public Task powerOffVM_Task()
                     throws InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

RuntimeFault

RemoteException

powerOnVM_Task

public Task powerOnVM_Task(HostSystem host)
                    throws FileFault,
InsufficientResourcesFault,
InvalidState,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

promoteDisks_Task

public Task promoteDisks_Task(boolean unlink,
 VirtualDisk[] disks)
                       throws InvalidPowerState,
InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidPowerState

InvalidState

TaskInProgress

RuntimeFault

RemoteException

putUsbScanCodes

public int putUsbScanCodes(UsbScanCodeSpec spec)
                    throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

queryConnections

public VirtualMachineConnection[] queryConnections()
                                            throws InvalidState,
Timedout,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

InvalidState

Timedout

VmConfigFault

RuntimeFault

RemoteException

rebootGuest

public void rebootGuest()
                 throws InvalidState,
TaskInProgress,
ToolsUnavailable,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

ToolsUnavailable

RuntimeFault

RemoteException

reconfigVM_Task

public Task reconfigVM_Task(VirtualMachineConfigSpec spec)
                     throws ConcurrentAccess,
DuplicateName,
FileFault,
InsufficientResourcesFault,
InvalidDatastore,
InvalidName,
InvalidState,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

ConcurrentAccess

DuplicateName

FileFault

InsufficientResourcesFault

InvalidDatastore

InvalidName

InvalidState

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

refreshStorageInfo

public void refreshStorageInfo()
                        throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

reloadVirtualMachineFromPath_Task

public Task reloadVirtualMachineFromPath_Task(String configurationPath)
                                       throws AlreadyExists,
FileFault,
InvalidPowerState,
InvalidState,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

AlreadyExists

FileFault

InvalidPowerState

InvalidState

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

relocateVM_Task

public Task relocateVM_Task(VirtualMachineRelocateSpec spec,
 VirtualMachineMovePriority priority)
                     throws FileFault,
InsufficientResourcesFault,
InvalidDatastore,
InvalidState,
MigrationFault,
Timedout,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidDatastore

InvalidState

MigrationFault

Timedout

VmConfigFault

RuntimeFault

RemoteException

removeAllSnapshots_Task

public Task removeAllSnapshots_Task(boolean consolidate,
 SnapshotSelectionSpec spec)
                             throws InvalidState,
SnapshotFault,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidState

SnapshotFault

TaskInProgress

RuntimeFault

RemoteException

resetVM_Task

public Task resetVM_Task()
                  throws InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

RuntimeFault

RemoteException

resetGuestInformation

public void resetGuestInformation()
                           throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

revertToCurrentSnapshot_Task

public Task revertToCurrentSnapshot_Task(HostSystem host,
 boolean suppressPowerOn)
                                  throws InsufficientResourcesFault,
InvalidState,
NotFound,
SnapshotFault,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

InsufficientResourcesFault

InvalidState

NotFound

SnapshotFault

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

sendNMI

public void sendNMI()
             throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

setDisplayTopology

public void setDisplayTopology(VirtualMachineDisplayTopology[] displays)
                        throws InvalidState,
ToolsUnavailable,
RuntimeFault,
RemoteException

Throws:

InvalidState

ToolsUnavailable

RuntimeFault

RemoteException

setScreenResolution

public void setScreenResolution(int width,
 int height)
                         throws InvalidState,
ToolsUnavailable,
RuntimeFault,
RemoteException

Throws:

InvalidState

ToolsUnavailable

RuntimeFault

RemoteException

shutdownGuest

public void shutdownGuest()
                   throws InvalidState,
TaskInProgress,
ToolsUnavailable,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

ToolsUnavailable

RuntimeFault

RemoteException

standbyGuest

public void standbyGuest()
                  throws InvalidState,
TaskInProgress,
ToolsUnavailable,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

ToolsUnavailable

RuntimeFault

RemoteException

startRecording_Task

public Task startRecording_Task(String name,
 String description)
                         throws FileFault,
HostIncompatibleForRecordReplay,
InvalidName,
InvalidPowerState,
InvalidState,
RecordReplayDisabled,
SnapshotFault,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

HostIncompatibleForRecordReplay

InvalidName

InvalidPowerState

InvalidState

RecordReplayDisabled

SnapshotFault

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

startReplaying_Task

public Task startReplaying_Task(VirtualMachineSnapshot replaySnapshot)
                         throws FileFault,
HostIncompatibleForRecordReplay,
InvalidPowerState,
InvalidState,
NotFound,
RecordReplayDisabled,
SnapshotFault,
TaskInProgress,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

FileFault

HostIncompatibleForRecordReplay

InvalidPowerState

InvalidState

NotFound

RecordReplayDisabled

SnapshotFault

TaskInProgress

VmConfigFault

RuntimeFault

RemoteException

stopRecording_Task

public Task stopRecording_Task()
                        throws FileFault,
InvalidPowerState,
InvalidState,
SnapshotFault,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidPowerState

InvalidState

SnapshotFault

TaskInProgress

RuntimeFault

RemoteException

stopReplaying_Task

public Task stopReplaying_Task()
                        throws FileFault,
InvalidPowerState,
InvalidState,
SnapshotFault,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

FileFault

InvalidPowerState

InvalidState

SnapshotFault

TaskInProgress

RuntimeFault

RemoteException

suspendVM_Task

public Task suspendVM_Task()
                    throws InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

RuntimeFault

RemoteException

terminateVM

public void terminateVM()
                 throws InvalidState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

RuntimeFault

RemoteException

terminateFaultTolerantVM_Task

public Task terminateFaultTolerantVM_Task(VirtualMachine vm)
                                   throws InvalidState,
TaskInProgress,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

VmFaultToleranceIssue

RuntimeFault

RemoteException

turnOffFaultToleranceForVM_Task

public Task turnOffFaultToleranceForVM_Task()
                                     throws InvalidState,
TaskInProgress,
VmFaultToleranceIssue,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

VmFaultToleranceIssue

RuntimeFault

RemoteException

unmountToolsInstaller

public void unmountToolsInstaller()
                           throws InvalidState,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

InvalidState

VmConfigFault

RuntimeFault

RemoteException

unregisterVM

public void unregisterVM()
                  throws InvalidPowerState,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

InvalidPowerState

TaskInProgress

RuntimeFault

RemoteException

upgradeTools_Task

public Task upgradeTools_Task(String installerOptions)
                       throws InvalidState,
TaskInProgress,
ToolsUnavailable,
VmConfigFault,
VmToolsUpgradeFault,
RuntimeFault,
RemoteException

Throws:

InvalidState

TaskInProgress

ToolsUnavailable

VmConfigFault

VmToolsUpgradeFault

RuntimeFault

RemoteException

upgradeVM_Task

public Task upgradeVM_Task(String version)
                    throws AlreadyUpgraded,
InvalidState,
NoDiskFound,
TaskInProgress,
RuntimeFault,
RemoteException

Throws:

AlreadyUpgraded

InvalidState

NoDiskFound

TaskInProgress

RuntimeFault

RemoteException

getCurrentSnapShot

public VirtualMachineSnapshot getCurrentSnapShot()
                                          throws InvalidProperty,
RuntimeFault,
RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

getParentVApp

public ManagedEntity getParentVApp()

Since:

SDK4.1

getRootSnapshot

public VirtualMachineSnapshot[] getRootSnapshot()

Since:

SDK4.1

acquireMksTicket

@Deprecated
public VirtualMachineMksTicket acquireMksTicket()
                                         throws RuntimeFault,
RemoteException

Deprecated.

as of SDK4.1. Use acquireTicket instead.

Throws:

RuntimeFault

RemoteException

acquireTicket

public VirtualMachineTicket acquireTicket(String ticketType)
                                   throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

Since:

SDK4.1

cloneVM_Task

public Task cloneVM_Task(Folder folder,
 String name,
 VirtualMachineCloneSpec spec)
                  throws VmConfigFault,
TaskInProgress,
CustomizationFault,
FileFault,
InvalidState,
InsufficientResourcesFault,
MigrationFault,
InvalidDatastore,
RuntimeFault,
RemoteException

Throws:

VmConfigFault

TaskInProgress

CustomizationFault

FileFault

InvalidState

InsufficientResourcesFault

MigrationFault

InvalidDatastore

RuntimeFault

RemoteException

createSecondaryVMEx_Task

public Task createSecondaryVMEx_Task(HostSystem host)
                              throws FileFault,
InsufficientResourcesFault,
InvalidState,
ManagedObjectNotFound,
NotSupported,
RuntimeFault,
TaskInProgress,
VmConfigFault,
VmFaultToleranceIssue,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

ManagedObjectNotFound

NotSupported

RuntimeFault

TaskInProgress

VmConfigFault

VmFaultToleranceIssue

RemoteException

Since:

6.0

createSecondaryVMEx_Task

public Task createSecondaryVMEx_Task(FaultToleranceConfigSpec spec)
                              throws FileFault,
InsufficientResourcesFault,
InvalidState,
ManagedObjectNotFound,
NotSupported,
RuntimeFault,
TaskInProgress,
VmConfigFault,
VmFaultToleranceIssue,
RemoteException

Throws:

FileFault

InsufficientResourcesFault

InvalidState

ManagedObjectNotFound

NotSupported

RuntimeFault

TaskInProgress

VmConfigFault

VmFaultToleranceIssue

RemoteException

Since:

6.0

extractOvfEnvironment

public String extractOvfEnvironment()
                             throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

Since:

SDK4.0

markAsVirtualMachine

public void markAsVirtualMachine(ResourcePool pool,
 HostSystem host)
                          throws VmConfigFault,
FileFault,
InvalidState,
InvalidDatastore,
RuntimeFault,
RemoteException

Throws:

VmConfigFault

FileFault

InvalidState

InvalidDatastore

RuntimeFault

RemoteException

queryChangedDiskAreas

public DiskChangeInfo queryChangedDiskAreas(VirtualMachineSnapshot snapshot,
 int deviceKey,
 long startOffset,
 String changeId)
                                     throws FileFault,
NotFound,
RuntimeFault,
RemoteException

Throws:

FileFault

NotFound

RuntimeFault

RemoteException

Since:

SDK4.0

queryFaultToleranceCompatibility

@Deprecated
public LocalizedMethodFault[] queryFaultToleranceCompatibility()
                                                        throws InvalidState,
VmConfigFault,
RuntimeFault,
RemoteException

Deprecated.

As of 6.0 use queryFaultToleranceCompatibilityEx(java.lang.Boolean)

Throws:

InvalidState

VmConfigFault

RuntimeFault

RemoteException

Since:

SDK4.1

queryFaultToleranceCompatibilityEx

public LocalizedMethodFault[] queryFaultToleranceCompatibilityEx(Boolean forLegacyFt)
                                                          throws InvalidState,
VmConfigFault,
RuntimeFault,
RemoteException

This API can be invoked to determine whether a virtual machine is compatible for Fault Tolerance. The API only checks for VM-specific factors that impact compatibility for Fault Tolerance. Other requirements for Fault Tolerance such as host processor compatibility, logging nic configuration and licensing are not covered by this API. The query returns a list of faults, each fault corresponding to a specific incompatibility. If a given virtual machine is compatible for Fault Tolerance, then the fault list returned will be empty.

Parameters:

forLegacyFt - checks for legacy record-replay FT compatibility only if this is set to true.

Returns:

Localized Method Fault

Throws:

InvalidState

VmConfigFault

RuntimeFault

RemoteException

Since:

6.0

queryFaultToleranceCompatibilityEx

public LocalizedMethodFault[] queryFaultToleranceCompatibilityEx()
                                                          throws InvalidState,
VmConfigFault,
RuntimeFault,
RemoteException

Throws:

InvalidState

VmConfigFault

RuntimeFault

RemoteException

Since:

6.0

queryUnownedFiles

public String[] queryUnownedFiles()
                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK4.0

relocateVM_Task

public Task relocateVM_Task(VirtualMachineRelocateSpec spec)
                     throws VmConfigFault,
Timedout,
FileFault,
InvalidState,
InsufficientResourcesFault,
MigrationFault,
InvalidDatastore,
RuntimeFault,
RemoteException

Throws:

VmConfigFault

Timedout

FileFault

InvalidState

InsufficientResourcesFault

MigrationFault

InvalidDatastore

RuntimeFault

RemoteException

removeAllSnapshots_Task

public Task removeAllSnapshots_Task()
                             throws SnapshotFault,
TaskInProgress,
InvalidState,
RuntimeFault,
RemoteException

Throws:

SnapshotFault

TaskInProgress

InvalidState

RuntimeFault

RemoteException

revertToCurrentSnapshot_Task

public Task revertToCurrentSnapshot_Task(HostSystem host)
                                  throws VmConfigFault,
SnapshotFault,
TaskInProgress,
InvalidState,
InsufficientResourcesFault,
NotFound,
RuntimeFault,
RemoteException

Throws:

VmConfigFault

SnapshotFault

TaskInProgress

InvalidState

InsufficientResourcesFault

NotFound

RuntimeFault

RemoteException

getDatastores

public Datastore[] getDatastores()

Backward-compat alias for getDatastore().