VMware vSphere Automation SDK Java: client README

VMware logo

The vSphere Automation SDK for Java enables programmatic access to vSphere. It includes java libraries for accessing features like Content Library, Tagging, Appliance Management and Virtual Machine Configuration and Operations.
It contains samples for the features mentioned above as well as samples to demonstrate how to interoperate with vSphere Web Services APIs. For more information about the vSphere Web Services APIs and samples, please refer to vSphere Management SDK.

This README contains the following topics:

Directory structure

The following table contains a brief description of the contents of the VMware-vSphere-Automation-SDK--Java/client directory.
DirectoryContentsDocumentation
apidocs vSphere Automation SDK javadoc Content Library, Tagging, Appliance Management, Virtual Machine Configuration and Operations
lib Client SDK, samples, other jars needed by the samples  
samples vSphere Automation Client SDK Java client samples for various features and workflows vSphere Automation Client SDK Java Client Samples README

Java SDK API Documentation

Content Library, Tagging, Appliance Management, Virtual Machine Configuration and Operations
Lookup Service
vSphere Management SDK

SDK and samples jars

For Java developers, precompiled client libraries are supplied for testing and development purposes. All the supplied jars are located under lib directory.

NameDescription
vapi-runtime-2.5.0.jarvAPI runtime for serialization/de-serialization of objects and wire protocol
vapi-authentication-2.5.0.jarvAPI authentication module
vapi-samltoken-2.5.0.jarvAPI samltoken module that handles SAML token parsing and validation
vsphereautomation-client-sdk-6.5.0.jarvSphere Automation Client bindings for the new features
vsphereautomation-client-samples-6.5.0.jarvSphere Automation Client SDK Java samples jar
vim25.jarvSphere Web Services client library vim25.jar generated from WSDL
ssoclient.jarvSphere SSO client library

Running a sample

Please refer to Running a sample for details.
  • run.sh is needed for running the samples in UNIX/mac OS X environment
  • run.bat is a windows bat file needed for running the samples in windows

Copyright © 2015,2016 VMware, Inc. All rights not expressly granted herein are reserved.

Last updated: 15th July 2016 |  VMware vSphere Automation SDK Java