VMware vSphere Python SDK
.. image:: https://travis-ci.org/vmware/pyvmomi.svg?branch=v6.0.0.2016.4 :target: https://travis-ci.org/vmware/pyvmomi :alt: Build Status
.. image:: https://img.shields.io/pypi/dm/pyvmomi.svg :target: https://pypi.python.org/pypi/pyvmomi/ :alt: Downloads
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 Python <https://www.python.org/downloads/>
, 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>
.
#pyvmomi and #pyvmomi-dev <http://webchat.freenode.net/?channels=#pyvmomi,#pyvmomi-dev>
_nabble <http://pyvmomi.2338814.n4.nabble.com>
_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
posted to pypi <https://pypi.python.org/pypi/pyvmomi/>
_
pip install --upgrade pyvmomi
. github <https://github.com/vmware/pyvmomi>
_ use
python setup.py develop
for 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>
_contribution standards <https://github.com/vmware/pyvmomi/wiki/Contributions>
_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 <https://vdc-download.vmware.com/vmwb-repository/dcr-public/6b586ed2-655c-49d9-9029-bc416323cb22/fa0b429a-a695-4c11-b7d2-2cbc284049dc/doc/index.html>
_pyVmomi versions are marked vSphereversion-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.
Have fun!