|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
VirtualMachine extends the ManagedEntity type because virtual machines are part of a virtual infrastructure inventory. The parent of a virtual machine must be a folder, and a virtual machine has no children.
Destroying a virtual machine disposes of all associated storage, including the virtual disks. To remove a virtual machine while retaining its virtual disk storage, a client must remove the virtual disks from the virtual machine before destroying it.
Properties
| Name | Type | Description |
|---|---|---|
| capability | VirtualMachineCapability | Information about the runtime capabilities of this virtual machine. |
| config* | VirtualMachineConfigInfo |
Configuration of this virtual machine, including the name and UUID.
This property is set when a virtual machine is created or when the reconfigVM method is called. The virtual machine configuration is not guaranteed to be available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the initial phases of virtual machine creation. |
| datastore* | ManagedObjectReference[]
to a Datastore[] | A collection of references to the subset of datastore objects in the datacenter that is used by this virtual machine. |
| environmentBrowser | ManagedObjectReference
to a EnvironmentBrowser | The current virtual machine's environment browser object. This contains information on all the configurations that can be used on the virtual machine. This is identical to the environment browser on the ComputeResource to which this virtual machine belongs. |
| guest* | GuestInfo | Information about VMware Tools and about the virtual machine from the perspective of VMware Tools. Information about the guest operating system is available in VirtualCenter. Guest operating system information reflects the last known state of the virtual machine. For powered on machines, this is current information. For powered off machines, this is the last recorded state before the virtual machine was powered off. |
| guestHeartbeatStatus | ManagedEntityStatus |
The guest heartbeat.
The heartbeat status is classified as:
|
| layout* | VirtualMachineFileLayout | Detailed information about the files that comprise this virtual machine. |
| network* | ManagedObjectReference[]
to a Network[] | A collection of references to the subset of network objects in the datacenter that is used by this virtual machine. |
| resourceConfig* | ResourceConfigSpec |
The resource configuration for a virtual machine. The shares
in this specification are evaluated relative to the resource pool
to which it is assigned. This will return null if the product
the virtual machine is registered on does not support resource
configuration.
To retrieve the configuration, you typically use childConfiguration. To change the configuration, use UpdateChildResourceConfiguration. |
| resourcePool* | ManagedObjectReference
to a ResourcePool |
The current resource pool that specifies resource allocation
for this virtual machine.
This property is set when a virtual machine is created or associated with a different resource pool. Returns null if the virtual machine is a template or the session has no access to the resource pool. |
| runtime | VirtualMachineRuntimeInfo |
Execution state and history for this virtual machine.
The contents of this property change when:
|
| snapshot* | VirtualMachineSnapshotInfo |
Current snapshot and tree.
The property is valid if snapshots have been created
for this virtual machine.
The contents of this property change in response to the methods: |
| summary | VirtualMachineSummary |
Basic information about this virtual machine. This includes:
|
| Properties inherited from ManagedEntity | ||
| configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, triggeredAlarmState | ||
Methods
| Methods defined in this Managed Object |
|---|
| AcquireMksTicket, AnswerVM, CheckCustomizationSpec, CloneVM_Task, CreateSnapshot_Task, CustomizeVM_Task, MarkAsTemplate, MarkAsVirtualMachine, MigrateVM_Task, MountToolsInstaller, PowerOffVM_Task, PowerOnVM_Task, RebootGuest, ReconfigVM_Task, RelocateVM_Task, RemoveAllSnapshots_Task, ResetGuestInformation, ResetVM_Task, RevertToCurrentSnapshot_Task, SetScreenResolution, ShutdownGuest, StandbyGuest, SuspendVM_Task, UnmountToolsInstaller, UnregisterVM, UpgradeTools_Task, UpgradeVM_Task |
| Methods inherited from ManagedEntity |
| Destroy_Task, Reload, Rename_Task |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
Return Value
| Type | Description |
|---|---|
| VirtualMachineMksTicket | A one-time credential used in establishing a remote mouse-keyboard-screen connection. |
Faults
| Type | Description |
|---|---|
| NotSupported | Thrown if it cannot retrieve TCP binding information about the client connection. For example, TCP binding information is not available for a client connection that is not TCP-based. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| questionId | xsd:string | The value from QuestionInfo.id that identifies the question to answer. |
| answerChoice | xsd:string | The contents of the QuestionInfo.choice.value array element that identifies the desired answer. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| ConcurrentAccess | Thrown if the question has been or is being answered by another thread or user. |
| InvalidArgument | Thrown if the questionId does not apply to this virtual machine. For example, this can happen if another client already answered the message. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| spec | CustomizationSpec | The customization specification to check. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| CustomizationFault | A subclass of CustomizationFault is thrown. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
The privilege required on the source virtual machine depends on the source and destination types:
The Resource.AssignVMToPool privilege is also required for the resource pool specified in the CloneSpec, if the destination is not a template.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| folder P | ManagedObjectReference
to a Folder | The location of the new virtual machine. |
| name | xsd:string | The name of the new virtual machine. |
| spec | VirtualMachineCloneSpec | Specifies how to clone the virtual machine. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly added VirtualMachine upon success. |
Faults
| Type | Description |
|---|---|
| CustomizationFault | Thrown if a customization error happens. Typically, a specific subclass of this exception is thrown. |
| FileFault | Thrown if there is an error accessing the virtual machine files. |
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidArgument | Thrown if the host cannot run this virtual machine. |
| InvalidDatastore | Thrown if the operation cannot be performed on the target datastores. |
| InvalidPowerState | Thrown if the virtual machine is powered on. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| MigrationFault | Thrown if it is not possible to migrate the virtual machine to the destination host. This is typically due to hosts being incompatible, such as mismatch in network polices or access to networks and datastores. Typically, a more specific subclass is thrown. |
| NotSupported | Thrown if the operation is not supported by the current agent. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| VmConfigFault | Thrown if the virtual machine is not compatible with the destination host. Typically, a specific subclass of this exception is thrown, such as IDEDiskNotSupported. |
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| name | xsd:string | The name for this snapshot. The name need not be unique for this virtual machine. |
| description* | xsd:string | A description for this snapshot. If omitted, a default description may be provided. |
| memory | xsd:boolean |
If TRUE, a dump of the internal state of the virtual machine
(basically a memory dump) is included in the snapshot. Memory snapshots
consume time and resources, and thus take longer to create. When set to FALSE,
the power state of the snapshot is set to powered off.
capabilities indicates whether or not this virtual machine supports this operation. |
| quiesce | xsd:boolean | If TRUE and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If the virutal machine is powered off or VMware Tools are not available, the quiesce flag is ignored. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly created VirtualMachineSnapshot upon success. |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if there is a problem with creating or accessing one or more files needed for this operation. |
| InvalidName | Thrown if the specified snapshot name is invalid. |
| InvalidPowerState | Thrown if the operation cannot be performed in the current power state of the virtual machine. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, the virtual machine configuration information is not available. |
| NotSupported | Thrown if the host product does not support snapshots or if the host does not support quiesced snapshots and the quiesce parameter is set to true. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| SnapshotFault | Thrown if an error occurs during the snapshot operation. Typically, a more specific fault like MultipleSnapshotsNotSupported is thrown. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| VmConfigFault | Thrown if the virtual machine's configuration is invalid. Typically, a more specific fault like InvalidSnapshotState is thrown. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| spec | CustomizationSpec | The customization specification object. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| CustomizationFault | A subclass of CustomizationFault is thrown. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
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 | Thrown if the virtual machine is not powered off. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| NotSupported | Thrown if marking a virtual machine as a template is not supported. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VmConfigFault | Thrown if the template is incompatible with the host, such as the files are not accessible. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| pool P | ManagedObjectReference
to a ResourcePool | Resource pool to associate with the virtual machine. |
| host* | ManagedObjectReference
to a HostSystem | The target host on which the virtual machine is intended to run. The host parameter must specify a host that is a member of the ComputeResource indirectly specified by the pool. For a stand-alone host or a cluster with DRS, it can be omitted and the system selects a default. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if we failed to access the virtual machine files. |
| InvalidDatastore | Thrown if the operation cannot be performed on the target datastores. |
| InvalidState | Thrown if the virtual machine is not marked as a template. |
| NotSupported | Thrown if marking a template as a virtual machine is not supported. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VmConfigFault | Thrown if the virtual machine is not compatible with the host. For example, a DisksNotSupported fault if the destination host does not support the disk backings of the template. |
Requires Resource.HotMigrate privilege if the virtual machine is powered on or Resource.ColdMigrate privilege if the virtual machine is powered off or suspended. Also requires Resource.AssignVMToPool on the virtual machine if the optional pool argument it set.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| pool* P | ManagedObjectReference
to a ResourcePool | The target resource pool for the virtual machine. If the pool parameter is left unset, the virtual machine's current pool is used as the target pool. |
| host* | ManagedObjectReference
to a HostSystem | The target host to which the virtual machine is intended to migrate. The host parameter may be left unset if the compute resource associated with the target pool represents a stand-alone host or a DRS-enabled cluster. In the former case the stand-alone host is used as the target host. In the latter case, the DRS system selects an appropriate target host from the cluster. |
| priority | VirtualMachineMovePriority | The priority of the migration task. |
| state* | VirtualMachinePowerState | If specified, the virtual machine migrates only if its state matches the specified state. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if, in a case where the virtual machine configuration file must be copied, the destination location for that file does not have the necessary file access permissions. |
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidArgument | Thrown if the target host and target pool are not associated with the same compute resource or if the host parameter is left unset when the target pool is associated with a non-DRS cluster. |
| InvalidPowerState | Thrown if the state argument is set and the virtual machine does not have that power state. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state or the target host's current state. For example, if the virtual machine configuration information is not available or if the target host is disconnected or in maintenance mode. |
| MigrationFault | Thrown if it is not possible to migrate the virtual machine to the destination host. This is typically due to hosts being incompatible, such as mismatch in network polices or access to networks and datastores. Typically, a more specific subclass is thrown. |
| NoActiveHostInCluster | Thrown if a target host is not specified and the cluster associated with the target pool does not contain at least one potential target host. A host must be connected and not in maintenance mode in order to be considered as a potential target host. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout | Thrown if one of the phases of the migration process times out. |
| VmConfigFault | Thrown if the virtual machine is not compatible with the destination host. Typically, a specific subclass of this exception is thrown, such as IDEDiskNotSupported. |
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 | Thrown if the virtual machine is not running, or the VMware Tools CD is already mounted. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidPowerState | Thrown if the power state is not poweredOn. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| host* | ManagedObjectReference
to a HostSystem | (optional) The host where the virtual machine is to be powered on. If no host is specified, the current associated host is used. This field must specify a host that is part of the same compute resource that the virtual machine is currently associated with. If this host is not compatible, the current host association is used. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if there is a problem accessing the virtual machine on the filesystem. |
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidPowerState | Thrown if the power state is poweredOn. |
| InvalidState | Thrown if the host is in maintenance mode or if the virtual machine's configuration information is not available. |
| NotEnoughLicenses | Thrown if there are not enough licenses to power on this virtual machine. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| VmConfigFault | Thrown if a configuration issue prevents the power-on. Typically, a more specific fault, such as UnsupportedVmxLocation, is thrown. |
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 | Thrown if the power state is not powered on. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| ToolsUnavailable | Thrown if VMware Tools is not running. |
Reconfiguring the virtual machine may require any of the following privileges depending on what is being changed:
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| spec | VirtualMachineConfigSpec | The new configuration values. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| ConcurrentAccess | Thrown if the changeVersion does not match the server's changeVersion for the configuration. |
| DuplicateName | Thrown if the specified name already exists in the parent folder. |
| FileFault | Thrown if there is a problem creating or accessing the virtual machine's files for this operation. Typically a more specific fault like NoDiskSpace or FileAlreadyExists is thrown. |
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidDatastore | |
| InvalidName | Thrown if the specified name is invalid. |
| InvalidPowerState | Thrown if the power state is poweredOn and the virtual hardware cannot support the configuration changes. |
| InvalidState | Thrown if the operation cannot be performed in the current state of the virtual machine. For example, because the virtual machine's configuration is not available. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| TooManyDevices | Thrown if the device specifications exceed the allowed limits. |
| VmConfigFault | Thrown if the spec is invalid. Typically, a more specific subclass is thrown. |
Requires Resource.ColdMigrate privilege
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| spec | VirtualMachineRelocateSpec | The specification of where to relocate the virtual machine. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if there is an error accessing the virtual machine files. |
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidArgument | in the following cases:
|
| InvalidDatastore | Thrown if the operation cannot be performed on the target datastores. |
| InvalidPowerState | Thrown if the virtual machine is not in a powered off or suspended state. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| MigrationFault | Thrown if it is not possible to migrate the virtual machine to the destination host. This is typically due to hosts being incompatible, such as mismatch in network polices or access to networks and datastores. Typically, a more specific subclass is thrown. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| Timedout | Thrown if one of the phases of the relocate process times out. |
| VmConfigFault | Thrown if the virtual machine is not compatible with the destination host. Typically, a specific subclass of this exception is thrown, such as IDEDiskNotSupported. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidPowerState | Thrown if the operation cannot be performed in the current power state of the virtual machine. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| NotSupported | Thrown if the host product does not support snapshots. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| SnapshotFault | Thrown if an error occurs during the snapshot operation. Typically, a more specific fault like InvalidSnapshotFormat is thrown. |
| TaskInProgress | Thrown if the virtual machine is busy. |
This method can be useful if stale information is cached, preventing an IP address or MAC address from being reused.
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 | Thrown if VMware Tools is running. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Although this method functions as a powerOff followed by a powerOn, the two operations are atomic with respect to other clients, meaning that other power operations cannot be performed until the reset method completes.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidPowerState | Thrown if the power state is suspended. |
| InvalidState | Thrown if the host is in maintenance mode. |
| NotEnoughLicenses | Thrown if there are not enough licenses to reset this virtual machine. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
If no snapshot exists, then the operation does nothing, and the virtual machine state remains unchanged.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| host* | ManagedObjectReference
to a HostSystem |
(optional) Choice of host for the virtual machine,
in case this operation causes the virtual machine to power on.
If a snapshot was taken while a virtual machine was powered on, and this operation is invoked after the virtual machine was powered off, the operation causes the virtual machine to power on to reach the snapshot state. This parameter can be used to specify a choice of host where the virtual machine should power on. If this parameter is not set, and the vBalance feature is configured for automatic load balancing, a host is automatically selected. Otherwise, the virtual machine keeps its existing host affiliation. This is not supported for virtual machines associated with hosts on ESX 2.x servers. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InsufficientResourcesFault | Thrown if this operation would violate a resource usage policy. |
| InvalidPowerState | Thrown if the operation cannot be performed in the current power state of the virtual machine. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| NotFound | Thrown if the virtual machine does not have a current snapshot. |
| NotSupported | Thrown if the host product does not support snapshots. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| SnapshotFault | Thrown if an error occurs during the snapshot operation. Typically, a more specific fault like InvalidSnapshotFormat is thrown. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| VmConfigFault | Thrown if a configuration issue prevents the power-on. Typically, a more specific fault, such as UnsupportedVmxLocation, is thrown. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| width | xsd:int | The screen width that should be set. |
| height | xsd:int | The screen height that should be set. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidPowerState | Thrown if the power state is not poweredOn. |
| NotSupported | Thrown if the Guest Operating system does not support setting the screen resolution. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| ToolsUnavailable | Thrown if VMware Tools is not running. |
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 | Thrown if the power state is not powered on. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| ToolsUnavailable | Thrown if VMware Tools is not running. |
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 | Thrown if the power state is not powered on. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| ToolsUnavailable | Thrown if VMware Tools is not running. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidPowerState | Thrown if the power state is not poweredOn. |
| InvalidState | Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available. |
| NotSupported | Thrown if the virtual machine is marked as a template. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
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 | Thrown if the virtual machine is not running, VMware Tools is not running or the VMware Tools CD is already mounted. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Use the Folder.RegisterVM method to recreate a VirtualMachine object from the set of virtual machine files by passing in the path to the configuration file. However, the VirtualMachine managed object that results typically has different objects ID and may inherit a different set of permissions.
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 | Thrown if the virtual machine is powered on. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| installerOptions* | xsd:string | Command line options passed to the installer to modify the installation procedure for tools. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the virtual machine is not running or an upgrade is already taking place. |
| NotSupported | Thrown if upgrading tools is not supported. |
| 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 | Thrown if VMware Tools is not running. |
| VmToolsUpgradeFault |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VirtualMachine used to make the method call. |
| version* | xsd:string | If specified, upgrade to that specified version. If not specified, upgrade to the most current virtual hardware supported on the host. |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
| Type | Description |
|---|---|
| AlreadyUpgraded | Thrown if the virtual machine's hardware is already up-to-date. |
| InvalidPowerState | Thrown if the power state is not poweredOff. |
| InvalidState | Thrown if the host is in maintenance mode, if an invalid version string is specified, or if the virtual machine is in a state in which the operation cannot be performed. For example, if the configuration information is not available. |
| NoDiskFound | Thrown if no virtual disks are attached to this virtual machine. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| TaskInProgress | Thrown if the virtual machine is busy. |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |