VIX API

Developer Community  |  Technical Papers  |  Knowledge Base  |  Downloads

The VIX API allows you to write programs and scripts that automate virtual machine operations, and run programs or manipulate files within guest operating systems. This API is high-level, easy to use, and practical for both script writers and application programmers. It runs on either Windows or Linux and supports management of VMware Workstation, VMware Server, and VMware vSphere including ESX/ESXi through vCenter Server. Bindings are provided for C, Perl, and COM (Visual Basic, VBscript, C#).

VIX API 1.10 Beta

Released 2 Feb 2010.

This is the preliminary standalone VIX release that runs with VMware vSphere 4.x beta and candidate builds. This release also bundles earlier VIX libraries, including the libraries delivered for Workstation and VMware Server.

Documentation Resources:

The VIX 1.10 Beta Release Notes with information about this beta release.
Information about vSphere 4 in the VIX 1.7 Release Notes also applies to this release.
In the download bits, the VIX API Reference has an introduction to VIX programming.
Using vmrun to Control Virtual Machines about the 1.10 vmrun utility.

Other Resources:

Download the VIX API.
To access the VIX API community forum, click here.

VIX API 1.8.1

Released 10 Nov 2009.

This is the standalone VIX release that runs with Workstation 7 and Player 3. This release also bundles earlier VIX libraries, including the libraries delivered for vSphere 4 and Workstation 6.x.

Documentation Resources:

The VIX 1.8.1 Release Notes with information about Workstation 7 and Player 3.
Information about vSphere 4 in the VIX 1.7 Release Notes also applies to this release.
The VIX API 1.8 Reference includes an introduction to VIX programming.
Using vmrun to Control Virtual Machines about the 1.8 vmrun utility.
Getting Started with the VIX API for VMware Player technical note.

Other Resources:

Download the VIX API.
To access the VIX API community forum, click here.

Sample Code:

powerOn.c – Shows how to open a virtual machine, power it on, and power it off.
suspend.c – Demonstrates how to power on, suspend, and resume a virtual machine.
snapshot.c – Opens a virtual machine, creates a snapshot, and reverts to snapshot state.
guestOps.c – Demonstrates how to perform operations in a guest virtual machine.
fhostopen.c – Finds all running virtual machines and opens a handle to each.
callbackProc.c – Shows how to use callback procedures with asynchronous VIX functions.
Makefile for Linux make and nMakefile for Windows nmake.

VIX API 1.7

Released 26 Aug 2009. Superseded VIX 1.6.2, released 3 Dec 2008.

Documentation Resources:

The VIX 1.7 Release Notes for ESX/ESXi and VMware vSphere 4.
The VIX API 1.7 Reference includes an introduction to VIX programming.
Using vmrun to Control Virtual Machines about the 1.7 vmrun utility.

Other Resources:

Download the VIX API.
To access the VIX API community forum, click here.

VIX API 1.6

Released 29 Oct 2008 and 21 Nov 2008.

Documentation Resources:

The VIX 1.6.1 Release Notes for VMware Workstation 6.5.1.
The VIX 1.6.0 Release Notes for VMware Server 2.0.
The VIX API 1.6 Reference includes an introduction to VIX programming.
Using vmrun to Control Virtual Machines about the vmrun utility.

Other Resources:

Download the VIX API.
To access the VIX API community forum, click here.

VIX API 1.1.5

Released 28 Aug 2008 | Build 109488

Documentation Resources:

The 1.1.5 Release Notes for VMware Workstation 6.0.5.
The VIX API 1.1 Reference includes an introduction to VIX programming.

Other Resources:

Download the VIX API.
To access the VIX API community forum, click here.

Sample Code:

powerOn.c – A simple program that powers on and off a virtual machine.
suspend.c – A simple program that suspends a running virtual machine.
snapshot.c – A simple program that takes a snapshot of a virtual machine.
callbackProc.c – A program that describes how to use the API asynchronously.
eventPump.c – A program that describes how to integrate the API in another application that may use a UI event pump.