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.
Getting Started
To get started, see the getting started guide. You’ll need Python, pip, and the samples project.
Installing
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 or if you want sso support pip install --upgrade pyvmomi[sso].
To install the github project run pip install ".[sso]" or if you want a development mode installation pip install -e ".[sso]".
Testing
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 3.14 then tox -e py314 will limit your test run to Python 3.14.
Contributing
Research open issues
Follow the contribution standards
Documentation
For general language neutral documentation of vSphere Management API see:
Python Support
pyVmomi supports Python 3.10+
Versioning
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.
Support
Support details can be referenced under the SDK and API Support for Commercial and Enterprise Organizations section at Broadcom Developer Portal.
For community support, please open a Github issue or start a Discussion.
4 maintainers
Release files for pyvmomi 9.1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyvmomi-9.1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / pyvmomi-9.1.1.0-py3-none-any.whl
| Download URL | pyvmomi-9.1.1.0-py3-none-any.whl |
|---|---|
| Size | 557.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
76af3cba85573769daf4e6760aace32e7af34e1bbf343895b8c4798b6bc0e2d2
|
|
BLAKE2b-256 checksum How to use checksums |
e018044c8a0c8f6ac16642e65f4fac19653291c7f6c5ab61a3734c9f6066a87b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
