VMware vSphere Automation Python SDK README

VMware logo

The VMware vSphere Automation SDK for Python enables programmatic access to vSphere. Access to capabilities exposed through the vSphere Web Services API is done using the open-source pyVmomi project. The SDK includes python libraries for accessing new features like Content Library and existing features like Tagging which did not support a public API prior to vSphere 6.5.
The SDK contains samples for the features mentioned above as well as samples to demonstrate how to interoperate with vSphere APIs. If you want to look at the vSphere API samples, please refer to pyVmomi community samples.
This README contains the following topics:

Intended Audience

The VMware vSphere Automation SDK for Python is intended for the following audiences:

  • Developers who want to write new application(s) for vSphere 6.5.
  • Developers migrating an existing vSphere application to use new features.

Prerequisites

For exercising the samples included in this SDK, you need a vSphere 6.5 deployment. Refer to vSphere product documentation for more information and specific installation and deployment options.

System Requirements

vSphere Automation SDK for Python 6.5 supports python 2.7, 3.3, 3.4 and 3.5
Note: VMware strongly recommends using openssl version 1.0.1j or, higher because of some critical security fixes.
Currently we test the SDK and samples on python 2.7, 3.3, 3.4 and 3.5 on these operating systems:
  • x86-64 RHEL 7
  • 64 bit Windows 10
  • OS X 10.11.6 El Capitan

Please see the instructions for installing the SDK and 3rd party libraries.

What’s in the SDK Package?

The vSphere Automation SDK for Python contains:

  • Python libraries, API reference documentation for features like Content Library and Tagging.
  • WSDL for lookup service API (required for Service Registration and Discovery).
  • Samples for new features and services which also demonstrate how to interoperate new APIs with vSphere APIs.

The following table contains a brief description of the contents of the vSphere Automation SDK for Python.

Directory structure (under VMware-vSphereAutomation-Python-SDK):

DirectoryContentsDocumentation
client Client libraries, API documentation and samples Client SDK README
docs API reference documentation and documentation resource files Client SDK API Reference Index

VMware Resources


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

Last updated: 26 Oct 2016 |  VMware vSphere Automation Python SDK