.. image:: https://travis-ci.org/vmware/pyvmomi.svg?branch=v188.8.131.526.4 :target: https://travis-ci.org/vmware/pyvmomi :alt: Build Status
pyVmomi is the Python SDK for the VMware vSphere API that allows you to manage ESX, ESXi, and vCenter.
To get started, see the
getting started guide <http://vmware.github.io/pyvmomi-community-samples/#getting-started>. You'll need
pip <https://pip.pypa.io/en/latest/installing.html#using-package-managers>, and the
samples project <https://github.com/vmware/pyvmomi-community-samples/tarball/master>.
- community discussion on IRC freenode.net channels
#pyvmomi and #pyvmomi-dev <http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev>_
- community email is on
Don't know what pip is? Any serious python developer should know, so here's a
throrough intro to pip <http://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/>_ that we like.
The master is code that is in development, official releases are tagged and
- The official release is available using pip, just run
pip install --upgrade pyvmomi.
- To install the version in
github <https://github.com/vmware/pyvmomi>_ use
python setup.py developfor development install or
python setup.py install.
Unit tests can be invoked by using the
tox <https://testrun.org/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.
open issues <https://github.com/vmware/pyvmomi/issues?q=is%3Aopen+is%3Aissue>_
- Follow the
contribution standards <https://github.com/vmware/pyvmomi/wiki/Contributions>_
- Coordinate with
other developers <http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev>_ on the project.
For general language neutral documentation of vSphere Management API see:
vSphere WS SDK API Docs <http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/right-pane.html>_
- pyVmomi 184.108.40.2066.4 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
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.
220.127.116.116.4 <https://github.com/vmware/pyvmomi/tree/v18.104.22.1686.4>_ release notes https://github.com/vmware/pyvmomi/releases/tag/v22.214.171.1246.4
6.0.0 <https://github.com/vmware/pyvmomi/tree/v6.0.0>_ release notes https://github.com/vmware/pyvmomi/releases/tag/v6.0.0
5.5.0-2014.1.1 <https://github.com/vmware/pyvmomi/tree/v5.5.0-2014.1.1>_ release notes https://github.com/vmware/pyvmomi/releases/tag/v5.5.0-2014.1.1
5.5.0-2014.1 <https://github.com/vmware/pyvmomi/tree/v5.5.0-2014.1>_ release notes https://github.com/vmware/pyvmomi/releases/tag/v5.5.0-2014.1
5.1.0 <https://github.com/vmware/pyvmomi/tree/v5.1.0>_ release notes https://github.com/vmware/pyvmomi/releases/tag/v5.1.0
- Feature Incubator: pyvmomi-tools https://github.com/vmware/pyvmomi-tools
- Samples Project: https://github.com/vmware/pyvmomi-community-samples