pyVmomi is the Python SDK for the VMware vSphere Management API that allows you to rapidly build solutions integrated with VMware ESXi and vCenter Server. For accessing features from the vSphere Automation APIs (REST), please refer to the VMware vSphere Automation SDK for Python.
Table of Contents
To get started, see the getting started guide. You'll need Python, pip, and the samples project.
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 setup.py developfor development install orpython setup.py install. - To install github's version with sso support, just run
pip install -e ".[sso]"inside project's home folder.
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
For general language neutral documentation of vSphere Management API see:
- pyVmomi supports Python 3.4+
pyVmomi: X.Y.Z.U.P
vCenter-related: X.Y - (Major release), Z - (Update release), U - (Patch)
pyVmomi-related: P - (pyVmomi patches)
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.
For official support, users with 'Active - Premium SDK Support, Standard SDK Support, Premier/Success 360, and VMware Select Support can reach out to VMware Global Support for any issues in line with our SDK and API Support policy. For community support, please open a Github issue or start a Discussion.
- VMware vSphere Automation SDK for Python: https://github.com/vmware/vsphere-automation-sdk-python
- Samples Project: https://github.com/vmware/pyvmomi-community-samples
Have fun!