VMware vSphere Web Services SDK 4.0 Release Notes

Release Notes   |   Known Issues   |   Deprecations   |   Behavior Changes

Release date:   21-May-2009
Last Document Update:   14-May-2009

Build 164009 (ESX) and 162856 (vCenter Server) are the General Availability (GA) builds of the vSphere Web Services SDK 4.0 release.

Welcome to the vSphere Web Services SDK 4.0. In this release, the SDK has been enhanced to support new features of ESX/ESXi 4.0 and vCenter Server 4.0 systems.

This document contains the following information:

What’s New

This release of the vSphere Web Services SDK supports new features of vSphere 4.0, which are listed in What's New in VMware vSphere 4.0.

Important: The vSphere API Reference includes detailed lists of new managed object types, data object types and properties, enumerations, and fault type. The Reference also includes an API Versions Reference page, which lists which version each object, fault, and enumeration supports.

This release of the vSphere Web Services SDK also includes a small number of additional new features, a substantial number of new samples and documentation improvements

New Features

In addition to the features listed in What's New in VMware vSphere 4.0, the vSphere Web Services SDK includes some new features that are of interest to developers.

Client credential store to support automated logon.   The client credential store consists of convenience libraries (Java, C# interfaces) for saving and retrieving authentication credentials in a local store on the client. Currently, supported credentials are limited to passwords only. The credential store facilitates running automated scripts. The SDK also includes command-line tools (Java, Microsoft PowerShell) for creating and managing a credential store on client machines. See the vSphere Web Services SDK Programming Guide for more information.

New SMS SDK for the Experimental Storage Monitoring Service API.   The Storage Monitoring Service (SMS) is installed by default on vCenter Server 4.0 systems. This service provides an experimental Web-services-based API that allows centralized access to all storage information across the datacenter. The SMS API provides a detail without the complexity of using the more general-purpose vSphere API. The SMS SDK is located in the \sms directory of the VMware vSphere Web Services SDK package. Open the SMS-SDK-README.html file in a Web browser to get started.

WSDLs for Multiple API Versions.   vSphere API 4.0 and VI API 2.0. The vSphere API 4.0 subsumes previous API versions, starting with VI API 2.5. The SDK package includes two versions of the WSDL files, located in these subdirectories:

  • The sdk\wsdl\vim25 subdirectory contains WSDL files for use with ESX 4.0, ESXi 4.0, vCenter Server 4.0, ESX 3.5, and VirtualCenter 2.5
  • The sdk\wsdl\vim subdirectory contains WSDL files for use with ESX Server 3.0.1 and VirtualCenter 2.0

Sample Code Enhancements

The SDK includes new C# and Java samples that demonstrate using new features. In addition, the sample helper classes use many of the new features and capabilities, such as the client-side credential store, targeting multiple servers that might be running different API versions, and saving session tokens (cookies) for reuse.

New C# Samples in the \SDK\samples\DotNet\cs subdirectory:

AddVirtualNic AddVirtualSwitch AddVirtualSwitchPortGroup AppUtil Basics Create CreateUser CredentialStorePSCmdlets Delete DeleteOneTimeScheduledTask DisplayNewProperties EventHistoryCollectorMonitor GetUpdates GetVirtualDiskFiles HostPowerOps LicenseManager MobStartPage Move OneTimeScheduledTask PrintCounters QueryMemoryOverhead RecordSession RemoveManagedObject RemoveVirtualNic RemoveVirtualSwitch RemoveVirtualSwitchPortGroup Rename SCSILunName SearchIndex SSPICIMClient TaskList VMClone VMCreate VMEventHistoryCollectorMonitor VMPowerStateAlarm VMReconfig VMSnapshot VMware.Security.CredentialStore WeeklyRecurrenceScheduledTask

New Java Samples in the \SDK\samples\Axis\java\com\vmware\samples subdirectory:


The \SDK\samples\Axis\java\com\vmware\security directory includes the credential store examples.

Documentation Improvements

vSphere API Reference   The main page of the vSphere API Reference includes comprehensive listings of the API versions and of new managed object types and new data object types. The documentation for many managed object types has been improved and clarified. For example, see the revised PerformanceManager and ViewManager documentation in the vSphere API Reference. The vSphere API Reference includes version information. New features available with ESX 4.0, ESXi 4.0, and vCenter Server 4.0 are labeled “Since vSphere API 4.0.”

vSphere Web Services SDK Programming Guide   The vSphere Web Services SDK Programming Guide has been reorganized and revised. It now includes UML diagrams and screenshots of the MOB (Managed Object Browser) to provide context and several instance diagrams that illustrate the inventory. The guide uses code examples from the SDK package.

Developer’s Setup Guide   The Developer’s Setup Guide has been revised tested with vSphere Web Services SDK 4.0.

Samples Documentation   The Java samples documentation (javadoc) now includes an Overview page with information about how to run the Java samples.

API Versions Interoperability

Client applications developed using previous releases of the vSphere Web Services SDK are compatible with vSphere 4.0.

The vSphere Web Services SDK 4.0 is compatible with previous releases of ESX/ESXi and VirtualCenter Server, including ESX/ESXi 3.5x, ESX/ESXi 3.0.x; VirtualCenter Server 2.5, and VirtualCenter Server 2.0.x. The vSphere Web Services SDK package includes WSDL files for vSphere API 4.0, which is a superset of API versions starting with API 2.5, and for VI API 2.0.

Unlike earlier releases of the API, the vSphere 4.0 API does not depend on the WSDL namespace attribute for version information. The namespace for vSphere 4.0 API remains urn:vim25.