pyvmomi travis-ci python

VMware vSphere API Python Bindings

3 years after

.. image:: :target: :alt: Build Status

.. image:: :target: :alt: Downloads

pyVmomi is the Python SDK for the VMware vSphere API that allows you to manage ESX, ESXi, and vCenter.

Getting Started

To get started, see the getting started guide <>. You'll need Python <>, pip <>, and the samples project <>.

  • community discussion on IRC channels #pyvmomi and #pyvmomi-dev <,#pyvmomi-dev>_
  • community email is on nabble <>_

Don't know what pip is? Any serious python developer should know, so here's a throrough intro to pip <>_ that we like.


The master is code that is in development, official releases are tagged and posted to pypi <>_

  • The official release is available using pip, just run pip install --upgrade pyvmomi.
  • To install the version in github <>_ use python develop for development install or python install.


Unit tests can be invoked by using the tox <>_ command. You may have to configure multiple python interpreters so that you can test in all the environments listed in tox.ini or you will have to run tox with the -e flag to run only in your version of python. For example, if you only have Python 2.7 then tox -e py27 will limit your test run to Python 2.7.


  • Research open issues <>_
  • Follow the contribution standards <>_
  • Coordinate with other developers <,#pyvmomi-dev>_ on the project.


For general language neutral documentation of vSphere Management API see:

  • vSphere WS SDK API Docs <>_

Python Support

  • pyVmomi and later support 2.7, 3.3 and 3.4
  • pyVmomi 6.0.0 and later support 2.7, 3.3 and 3.4
  • pyVmomi 5.5.0-2014.1 and 5.5.0-2014.1.1 support Python 2.6, 2.7, 3.3 and 3.4
  • pyVmomi 5.5.0 and below support Python 2.6 and 2.7

Compatibility Policy

pyVmomi versions are marked vSphere_version-release . Pyvmomi maintains minimum backward compatibility with the previous four releases of vSphere and it's own previous four releases. Compatibility with much older versions may continue to work but will not be actively supported.

For example, version v6.0.0 is most compatible with vSphere 6.0, 5.5, 5.1 and 5.0. Initial releases compatible with a version of vSphere will bare a naked version number of v6.0.0 indicating that version of pyVmomi was released simultaneously with the GA version of vSphere with the same version number.


Related Projects

Have fun!

Related Repositories



A place for community contributed samples for the pyVmomi library. ...



cli tool for common VMware vSphere tasks ...



The example codes are written using the VMware official python library pyvmomi ...



VMware vSphere Web Service client in Python ...



Docker Image to deploy various VMware and open source related tools to manage a ...

Top Contributors

hartsock tianhao64 mstagi michaelrice wiggin15 JLHasson parthgala pdellaert stacybrock joshk0 kevin1024 FrankCRoth userlocalhost2000 mmattioli tsugliani patricklundquist rallytime dananourie guangmuzhu ivuk InvalidInterrupt martinmosegaard cingeyedog lathrop-navisite stunes nmadhok esc higebu m9e


-   v6.0.0.2016.4 zip tar
-   v6.0.0 zip tar
-   v5.5.0.2014.1.1 zip tar
-   v5.5.0 zip tar
-   v5.5.0-2014.1.1 zip tar
-   v5.5.0-2014.1 zip tar
-   v5.1.0 zip tar