Skip to main content

VMware vSphere Python SDK

Project description


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.


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.

  • 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.



For general language neutral documentation of vSphere Management API see:

Python Support

  • 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)

Compatibility Policy

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 Premium SDK Support, Standard SDK Support and Premier/Success360 customers can reach out to VMware Global Support for any issues. For community support, please open a Github issue or start a Discussion

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvmomi- (852.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page