Virtual Machine APIs

Virtual Machine APIs

VirtualMachine is the managed object type for manipulating virtual machines, including templates that can be deployed (repeatedly) as new virtual machines.

This type provides methods for configuring and controlling a virtual machine.

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.

Operations

Virtual Machine Acquire Mks Ticket

Creates and returns a one-time credential used in establishing a remote mouse-keyboard-screen connection to this virtual machine.

Virtual Machine Acquire Ticket

Creates and returns a one-time credential used in establishing a specific connection to this virtual machine, for example, a ticket type of mks can be used to establish a remote mouse-keyboard-screen connection.

Virtual Machine Answer VM

Responds to a question that is blocking this virtual machine.

Virtual Machine Apply Evc Mode VM Task

Applies the EVC mode masks to the virtual machine.

Virtual Machine Attach Disk Task

Attach an existing disk to this virtual machine.

Virtual Machine Check Customization Spec

Checks the customization specification against the virtual machine configuration.

Virtual Machine Clone VM Task

Creates a clone of this virtual machine.

Virtual Machine Consolidate VM Disks Task

Consolidate the virtual disk files of the virtual machine by finding hierarchies of redo logs that can be combined without violating data dependency.

Virtual Machine Create Screenshot Task

Create a screen shot of a virtual machine.

Virtual Machine Create Secondary VM Task

Creates a secondary virtual machine to be part of this fault tolerant group.

Virtual Machine Create Secondary VM Ex Task

Creates a secondary virtual machine to be part of this fault tolerant group.

Virtual Machine Create Snapshot Task

Creates a new snapshot of this virtual machine.

Virtual Machine Create Snapshot Ex Task

Creates a new snapshot of this virtual machine.

Virtual Machine Crypto Unlock Task

Unlocks an encrypted virtual machine by sending the encryption keys for the Virtual Machine Home and all the Virtual Disks to the ESX Server.

Virtual Machine Customize VM Task

Customizes a virtual machine's guest operating system.

Virtual Machine Defragment All Disks

Defragment all virtual disks attached to this virtual machine.

Virtual Machine Destroy Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

Virtual Machine Detach Disk Task

Detach a disk from this virtual machine.

Virtual Machine Disable Secondary VM Task

Disables the specified secondary virtual machine in this fault tolerant group.

Virtual Machine Drop Connections

Force the virtual machine to drop the specified connections.

Virtual Machine Enable Secondary VM Task

Enables the specified secondary virtual machine in this fault tolerant group.

Virtual Machine Estimate Storage For Consolidate Snapshots Task

Estimate the temporary space required to consolidation disk files.

Virtual Machine Export Vm

Obtains an export lease on this virtual machine.

Virtual Machine Extract Ovf Environment

Returns the OVF environment for a virtual machine.

Virtual Machine Get Alarm Actions Enabled

Whether alarm actions are enabled for this entity.

Virtual Machine Get Available Field

List of custom field definitions that are valid for the object's type.

Virtual Machine Get Capability

Information about the runtime capabilities of this virtual machine.

Virtual Machine Get Config

Configuration of this virtual machine, including the name and UUID.

Virtual Machine Get Config Issue

Current configuration issues that have been detected for this entity.

Virtual Machine Get Config Status

The configStatus indicates whether or not the system has detected a configuration issue involving this entity.

Virtual Machine Get Custom Value

Custom field values.

Virtual Machine Get Datastore

A collection of references to the subset of datastore objects in the datacenter that is used by this virtual machine.

Virtual Machine Get Declared Alarm State

A set of alarm states for alarms that apply to this managed entity.

Virtual Machine Get Disabled Method

List of operations that are disabled, given the current runtime state of the entity.

Virtual Machine Get Effective Role

Access rights the current session has to this entity.

Virtual Machine Get Environment Browser

The current virtual machine's environment browser object.

Virtual Machine Get Guest

Information about VMware Tools and about the virtual machine from the perspective of VMware Tools.

Virtual Machine Get Guest Heartbeat Status

The guest heartbeat.

Virtual Machine Get Layout

Detailed information about the files that comprise this virtual machine.

Virtual Machine Get Layout Ex

Detailed information about the files that comprise this virtual machine.

Virtual Machine Get Name

Name of this entity, unique relative to its parent.

Virtual Machine Get Network

A collection of references to the subset of network objects in the datacenter that is used by this virtual machine.

Virtual Machine Get Overall Status

General health of this managed entity.

Virtual Machine Get Parent

Parent of this entity.

Virtual Machine Get Parent V App

Reference to the parent vApp.

Virtual Machine Get Permission

List of permissions defined for this entity.

Virtual Machine Get Recent Task

The set of recent tasks operating on this managed entity.

Virtual Machine Get Resource Config

The resource configuration for a virtual machine.

Virtual Machine Get Resource Pool

The current resource pool that specifies resource allocation for this virtual machine.

Virtual Machine Get Root Snapshot

The roots of all snapshot trees for the virtual machine.

Virtual Machine Get Runtime

Execution state and history for this virtual machine.

Virtual Machine Get Snapshot

Current snapshot and tree.

Virtual Machine Get Storage

Storage space used by the virtual machine, split by datastore.

Virtual Machine Get Summary

Basic information about this virtual machine.

Virtual Machine Get Tag

The set of tags associated with this managed entity.

Virtual Machine Get Triggered Alarm State

A set of alarm states for alarms triggered by this entity or by its descendants.

Virtual Machine Get Value

List of custom field values.

Virtual Machine Instant Clone Task

Creates a powered-on Instant Clone of a virtual machine.

Virtual Machine Make Primary VM Task

Makes the specified secondary virtual machine from this fault tolerant group as the primary virtual machine.

Virtual Machine Mark As Template

Marks a VirtualMachine object as being used as a template.

Virtual Machine Mark As Virtual Machine

Clears the 'isTemplate' flag and reassociates the virtual machine with a resource pool and host.

Virtual Machine Migrate VM Task

Migrates a virtual machine's execution to a specific resource pool or host.

Virtual Machine Mount Tools Installer

Mounts the VMware Tools CD installer as a CD-ROM for the guest operating system.

Virtual Machine Power Off VM Task

Powers off this virtual machine.

Virtual Machine Power On VM Task

Powers on this virtual machine.

Virtual Machine Promote Disks Task

Promotes disks on this virtual machine that have delta disk backings.

Virtual Machine Put Usb Scan Codes

Inject a sequence of USB HID scan codes into the keyboard.

Virtual Machine Query Changed Disk Areas

Get a list of areas of a virtual disk belonging to this VM that have been modified since a well-defined point in the past.

Virtual Machine Query Connections

Ask the virtual machine for a list of connections.

Virtual Machine Query Fault Tolerance Compatibility

This API can be invoked to determine whether a virtual machine is compatible for legacy Fault Tolerance.

Virtual Machine Query Fault Tolerance Compatibility Ex

This API can be invoked to determine whether a virtual machine is compatible for Fault Tolerance.

Virtual Machine Query Unowned Files

For all files that belong to the vm, check that the file owner is set to the current datastore principal user, as set by *HostDatastoreSystem.ConfigureDatastorePrincipal*

Virtual Machine Reboot Guest

Issues a command to the guest operating system asking it to perform a reboot.

Virtual Machine Reconfig VM Task

Reconfigures this virtual machine.

Virtual Machine Refresh Storage Info

Explicitly refreshes the storage information of this virtual machine, updating properties *VirtualMachine.storage*, *VirtualMachine.layoutEx* and *VirtualMachineSummary.storage*.

Virtual Machine Reload

Reload the entity state.

Virtual Machine Reload Virtual Machine From Path Task

Reloads the configuration for this virtual machine from a given datastore path.

Virtual Machine Relocate VM Task

Relocates a virtual machine to the location specified by *VirtualMachineRelocateSpec*.

Virtual Machine Remove All Snapshots Task

Remove all the snapshots associated with this virtual machine.

Virtual Machine Rename Task

Renames this managed entity.

Virtual Machine Reset Guest Information

Clears cached guest information.

Virtual Machine Reset VM Task

Resets power on this virtual machine.

Virtual Machine Revert To Current Snapshot Task

Reverts the virtual machine to the current snapshot.

Virtual Machine Send NMI

Send a non-maskable interrupt (NMI).

Virtual Machine Set Custom Value

Assigns a value to a custom field.

Virtual Machine Set Display Topology

Sets the console window's display topology as specified.

Virtual Machine Set Screen Resolution

Sets the console window's resolution as specified.

Virtual Machine Shutdown Guest

Issues a command to the guest operating system asking it to perform a clean shutdown of all services.

Virtual Machine Standby Guest

Issues a command to the guest operating system asking it to prepare for a suspend operation.

Virtual Machine Start Recording Task

Initiates a recording session on this virtual machine.

Virtual Machine Start Replaying Task

Starts a replay session on this virtual machine.

Virtual Machine Stop Recording Task

Stops a currently active recording session on this virtual machine.

Virtual Machine Stop Replaying Task

Stops a replay session on this virtual machine.

Virtual Machine Suspend VM Task

Suspends execution in this virtual machine.

Virtual Machine Terminate Fault Tolerant VM Task

Terminates the specified secondary virtual machine in a fault tolerant group.

Virtual Machine Terminate VM

Do an immediate power off of a VM.

Virtual Machine Turn Off Fault Tolerance For VM Task

Removes all secondary virtual machines associated with the fault tolerant group and turns off protection for this virtual machine.

Virtual Machine Unmount Tools Installer

Unmounts VMware Tools installer CD.

Virtual Machine Unregister VM

Removes this virtual machine from the inventory without removing any of the virtual machine's files on disk.

Virtual Machine Upgrade Tools Task

Begins the tools upgrade process.

Virtual Machine Upgrade VM Task

Upgrades this virtual machine's virtual hardware to the latest revision that is supported by the virtual machine's current host.