pyVmomi Documentation

Compatibility Policy

pyVmomi maintains minimum backward compatibility with the previous four releases of vSphere and its own previous four releases. While older versions may work, they are not actively supported.

Versioning Scheme

pyVmomi Version: X.Y.Z.U.P

vCenter-related components:

• X.Y: Major release
• Z: Update release
• U: Patch

pyVmomi-specific components:

• P: pyVmomi patches

It is important to choose the correct SDK based on the API type you need to access:

1. pyVmomi: Use this for the VMware vSphere Management API (SOAP-based). It is the primary SDK for integrating with VMware ESXi and vCenter Server.
2. VMware vSphere Automation SDK for Python: Use this if you need to access the vSphere Automation APIs (REST).

You can install pyVmomi using pip.

To install the official release, use pip install --upgrade pyvmomi. If you require SSO (Single Sign-On) support, install the [sso] extra.

If you are developing directly from the GitHub repository, you can install the project using pip install ".[sso]" or install it in editable (development) mode using pip install -e ".[sso]".

To begin using pyVmomi, it is recommended to follow the official getting started guide and use the community samples project to understand implementation patterns.

Prerequisites:

• Python
• pip
• pyVmomi Community Samples