6.0

Table Of Contents
VMware, Inc. 9
Chapter 1 About the vSphere Web Services SDK
This list is not comprehensive. Also, some of the operations pertain to the service as a whole, not specific hosts
or virtual machines. For example, load balancing can be a service-wide operation rather than a per-host or
per-virtual machine operation.
Downloading the vSphere Web Services SDK
The vSphere Web Services SDK, along with other VMware SDKs, is contained in the
vSphere Management SDK. You can find the vSphere Management SDK at
https://developercenter.vmware.com, which links to the My VMware service.
After you expand the vSphere Management SDK package, the Web Services SDK is in the subdirectory
SDK/vsphere-ws. You also need the SDK/ssoclient subdirectory for client authentication.
Configurations for Sample Authentication with Single Sign-On
The vSphere 6.0 release introduces a Platform Services Controller that can run on the same host as the vCenter
Server, or can be configured on a separate host. At this time, the two possible configurations are:
vCenter Server with an embedded Platform Services Controller (vCenter Single Sign-On Server,
Lookup Service Server,...). This is like traditional vSphere deployments.
vCenter Server with an external Platform Services Controller.
You will have to provide the vCenter Single Sign-On URL explicitly in order to run samples with the second
configuration. With the first configuration, there is no need to provide the vCenter Single Sign-On URL (since
the vCenter Single Sign-On service is embedded in the management node) and our SDK will continue to work
as before.
The SDK samples have always had the option to explicitly specify the vCenter Single Sign-On URL (whether
the vCenter Single Sign-On service is running inside or outside the management node). This is useful in cases
where the vCenter Single Sign-On service is deployed outside the vSphere management node like the second
configuration above.
When you log in to a vCenter Single Sign-On Server, you must be in a domain that has been added as a vCenter
Single Sign-On identity source. If that domain is not the default domain, you must include the domain name
as part of your user name, such as, administrator@vsphere.local. To learn more about configuring the vCenter
Single Sign-On Server, see vSphere Security.
vSphere Web Services SDK Package Contents
The vSphere Web Services SDK is a bundle that includes the following items:
WSDL files that define the API available on a VMware vSphere server (ESX, ESXi, and vCenter Server)
Web service.
Precompiled client-side libraries (vim.jar, vim25.jar) available for test purposes that were generated
from the WSDL. The vSphere Web Services API is packaged in the vim25.jar file and is available in the
SDK\vsphere-ws\wsdl\vim25 subdirectory.
Sample code demonstrating common use cases associated with managing virtual infrastructure. The
sample code includes compiled and ready-to-run Java class files and both Java and C# source code files.
(For C# developers, the Microsoft Visual Studio project files (.sln) are included.)
Batch files and shell scripts (build.bat and build.sh) that automate the build process for Java and C#
client applications.
N
OTE The precompiled Java samples (samples.jar) were compiled using JDK 1.7 from stubs generated
by the Java API for XML Web Services (JAX-WS) libraries in J2SE 7.0, and work only with these specific
versions of Java and JAX-WS. To use a different version of Java, or a different client-side Web services
library, use the build script to rebuild the samples.