Programming Virtual Server 2005 with Visual Studio.NET

This article reviews portions of a C# application leveraging the VS2005 API. We will get you started with VS2005 here. The complete application code demonstrates one of the more interesting aspects of VMs: differencing hard drives. These drive disks allow you to toggle a VM from one configuration to a different configuration and back. This capability is especially useful for software testing and verification, where hardware resources are limited.

VS2005 is amazingly powerful but also adds a new level of complexity to server management. The VS2005 background and code provided in this article are just the tip of the iceberg to get you started. Take some time to work with virtualization. You’ll quickly see how easily virtualization can benefit your organization.

Virtual Server Background
A full introduction to VS2005 could fill a book. The objective of this article is not to overwhelm you with details, but to show you how to write a simple interface program to VS2005 that does useful work. Before diving into code, some brief background on virtualization is necessary.

Virtualization enables a single physical server, or host, to be partitioned into many independently operating virtual servers. As depicted in Figure 1, the VS2005 software emulates the disk, network, keyboard/video/ mouse, processor, and memory needed to create a server. Each server is totally isolated from the others with no visibility into other VMs running on the same host. The virtualization software governs resource usage to ensure that one VM does not consume all of the host’s CPU capacity.

It is important to distinguish between hosts and VMs for VS2005 compatibility. The host that runs the virtualization software must be running Windows Server 2003 (Windows XP works but is not “supported”). The VMs run a broad range of operating systems, including most flavors of Linux, DOS, Novell, Windows NT, and recent Windows releases but Microsoft will only support Windows. Microsoft, in fact, intends for VMs to become the primary supported platform for Windows NT.

What Makes Virtualization Compelling?
Virtualization is compelling because of the increased efficiency and control it brings to the physical server data center. Our company, Surgient, Inc., is an on-demand enterprise software company whose applications automate software sales, marketing, training, and testing processes. Surgient has been using virtualization platforms since 2001 as early beta testers of first-generation virtual server products. During that time, we have deployed over a thousand hosts and uncountable VMs. If you’ve experienced the Microsoft Visual Studio.NET hands-on trial, then you’ve used the Surgient demo management product and you’ve also used a VM! The VMs powering that site have served over 100,000 demos of VS.NET.

From the beginning, we recognized that VMs were fundamentally different and much more flexible than physical servers. The host’s APIs enable programmatic control to manage the virtual servers. The price of this flexibility is additional planning and management of data center operations.

On a virtualization host, servers compete for limited amounts of memory (RAM), processor (CPU), and storage (disk). VS2005 VMs, like physical servers, need sufficient RAM to operate. They block out their full memory footprint on the host. You can, however, release a VM’s memory by turning off the VM, which enables you to maintain more VM configurations than you can concurrently run.

These idle virtual images voraciously consume large amounts of disk. This means that a typical host may not have enough space to store many idle 4-10 GB virtual image files. VS2005 partially solves this problem by allowing VMs to chain image files into differencing layers that share a common base image.

The VS2005 differencing layer technology is called differencing disks (undo drives are a variant of differencing disks). This technology enables you to create a base image of the operating system and then install applications into a difference disk layer. A single base image can then be used by several VMs that each have a unique differencing disk.

Virtualization Example
Our sample scenario is a code development and testing environment for a three-tier application. The host server is a dual-processor server with 2GB of RAM and 120GB of RAID 5 disk. The proposed demo application must support both SQL Server and Oracle, each of which requires at least 1GB of RAM for testing. How can we use VS2005 to test the application in all its permutations using only the host server?

Memory is the obvious contention point. Of the available 2GB on the host, one quarter is reserved as overhead for the host operating system and VS2005, leaving just 1.5GB for the three application tiers. Since the databases each require 1GB, the entire application will just barely run on the host. To test both database platforms, we will have to keep one turned off while we are testing the other. Toggling the servers will keep our RAM use within the limits of the host.

Storage is a less obvious but equally serious challenge. Assuming 100GB available of the 120GB total should give ample room to store VM disk files. If we assume 10GB per VM, then we could store 10 VMs. Ten quickly drops to five if we plan to keep one archive copy of each VM.

Differencing disks provide the solution to both these issues. Our database server requires a 4GB Windows 2003 base image and two distinct differencing disks (SQL at 4GB and Oracle at 6GB). Without differencing, the two servers would consume 18GB of disk. Sharing the base image uses just 14, saving 4GB of disk. It is not necessary to archive the shared base because it does not change. We do, however, want to archive each differencing disk. The total storage is 24 GB, down from 36 GB without the use of differencing disks (see Figure 2).

Toggling the VM power states and working with shared base images addresses the resource limitations of the host.

Programming Virtualization Control
To use our testing environment, we must create a small .NET application that toggles between server configurations by changing both the VM’s power state and its differencing disk configuration.

The C# sample application will provide the following features:

Create a VM with appropriate components, including differencing and undo drives
Manage the VM’s power (Start and Stop)
Change the disk configuration of an existing machine
Simple user interface
This article focuses on key VS2005 interfacing points in the application. The entire program is available online at here.
Before the program can run, it needs a reference for the VS2005 API. VS2005 provides a COM interface and requires a .NET Interop to use it. Visual Studio creates the Interop automatically when we add Microsoft Virtual Server from the COM Components tab from the Tools…Add/Remove Toolbox Items menu. This process will add the using Microsoft.VirtualServer.Interop reference to the code.

In addition to referencing the COM Interop, VS2005 requires COM security to enforce access control. Our sample application includes a dedicated class, COMServices, to provide this critical initialization. Your VS2005 application must include this or similar code. A call to COMServices. Initialize() is all that is needed before we can start using the VS2005 API.

The VS2005 API has two primary categories of functions. The first category controls the virtualization platform on the host, while the second controls states and attributes of individual VMs. The interface to the host is created by instantiating a new VMVirtualServerClass object. Once this object exists, it is possible to create VMVirtualMachine objects by either creating new VMs using CreateVirtualMachineVM or getting a reference to an existing VM using FindVirtualMachine.

The example application calls the host object “vs” for Virtual Server. Here is the code to attach to the host API:

VMVirtualServerClass vs = new VMVirtualServerClass();

Creating a Virtual Machine
The first step in creating a VM is deciding where to store the multigigabyte virtual disk files that store the data of the VM’s hard drives. The VS2005 default is to bury the files deep in the Documents and Settings directory tree, which can cause serious issues on systems with multiple partitions as the largest files default to the operating system’s partition. Change the default path for VMs from the VS2005 Web interface in the Virtual Server…Server Properties section. The VMs are stored in directories under the default virtual machine configuration folder. In this example, the host will store VMs on the second partition (d:) in the “vms” subdirectory.

Creating a VM is a multistep process. The basic CreateVirtualMachine method only creates a VM stub. The VM’s RAM, disk, and network must be configured before it is usable. However, you cannot just attach disk and network to a VM; you must “install” virtual devices before you can attach media to them. Specifically, you must add a network adapter to your VM before you can attach it to the network and you must specify which IDE or SCSI ports you are using when you attach drives.

The first step is to create the VM stub. The application calls the VM object vm. Here is the code requesting the host object to create a VM:

VMVirtualMachine vm = vs.CreateVirtualMachine(“vm01″,”d:\vms\vm01”);

With the VM stub, it is possible to configure the VM’s properties. Memory is the easiest to configure:

vm.Memory = 256;

Attaching a hard drive requires an existing virtual hard disk (VHD) file. You can use an existing one or create one dynamically. VHD files are configured to a maximum possible size and expand dynamically as data is added. The maximum size is specified in megabytes, so the code sample uses a 1K multiplication to improve readability. Here is how the host object is told to create a VHD file:

vs.CreateDynamicVirtualHardDisk(“d:\vms\vm01.vhd”, 16 * 1024)

Instead of creating a new disk (shown above), you can add a differencing disk to an existing hard disk. A differencing disk inherits the maximum size from its parent and also stores the parent’s location in its header. You must supply both a unique disk name and the parent disk when you create a difference disk:

vs.CreateDifferencingVirtualHardDisk(“d:\vms\vm02.vhd”,”d:\vms\parent.vhd”);

Once the disk file exists, it can be attached to the VM by selecting a bus (IDE or SCSI) and the bus address. If the disk is a differencing disk, only the difference disk file is provided for connection. The parent disk is not programmatically connected because the difference disk already has the reference location for its parent disk. In this example, VS2005 will connect the drive at address IDE 0:0:

vm.AddHardDiskConnection(“d:\vms\vm01.vhd”, VMDriveBusType.vmDriveBusType_IDE, 0, 0);

Undoable mode is an important VS2005 feature because it allows you to maintain a working session for your server. When using undoable drives, you can maintain, commit, or discard the working session. There is minimal performance impact for this feature, and it eliminates the time wasted recovering or rebuilding server environments. Undoable mode is an attribute of the VM and applies to all drives:

vm.undoable = true;

Connecting the new network adapter to the correct host network is more challenging. The result is that the attached adapters are available as a NetworkAdapters array on the VM object. To create the network adapter for the VM:

vm.AddNetworkAdaper();

When installed, VS2005 automatically creates a virtual network for each physical host network interface card (NIC) and an extra “internal” network that can be shared between VMs but is not externally connected. Virtual networks may be created or added from the Web interface in the Virtual Networks section. The host object offers an array of VirtualNetworks. Connect a VM to a network by providing a reference to the desired host network with AttachToVirtualNework method for an adapter:

vm.NetworkAdapters[1].AttachToVirtualNetwork(vs.VirtualNetworks[0]);

Managing VM Power
VS2005 allows absolute control over a VM’s power, including a saved state that releases a VM’s memory and CPU resources. Suspend is useful because the VM immediately resumes work when restarted, avoiding an operating system reboot.

Basic power management uses the VM’s Startup and TurnOff methods. These are not advised for most cases. TurnOff is dangerous because it does not gracefully shutdown, and Startup does not wait for the start before returning control.

To provide a graceful shutdown, the “Virtual Machine Additions” must be installed on the VM’s GuestOS – Microsoft’s name for the operating system running on the VM. VS2005 prompts you for the Additions in the Web interface. Once the additions are installed, you first check the CanShutdown property from the VM’s GuestOS attribute:

If (vm.GuestOS.CanShutown vm.GuestOS.Shutdown();

Waiting for start or shutdown completion requires asynchronous calls to the VS2005 interface. Many VS2005 methods return a VMTask object that can be used to monitor task completion:

VMTask vt = vs.GuestOS.Shutdown();
if (vt !=null) vt.WaitForCompletion(-1);