- Notifications
You must be signed in to change notification settings - Fork770
VMware vSphere API Python Bindings
License
vmware/pyvmomi
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
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 thevSphere Automation APIs(REST), please refer to theVMware vSphere Automation SDK for Python.
Table of Contents
To get started, see thegetting started guide.You'll needPython,pip, and thesamples project.
The master is code that is in development, official releases are tagged andposted topypi
- The official release is available using pip, just run
pip install --upgrade pyvmomi
. - To install the version ingithub use
python setup.py develop
for development install orpython setup.py install
. - To installgithub's version with sso support, just run
pip install -e ".[sso]"
inside project's home folder.
Unit tests can be invoked by using thetox command. You may have toconfigure multiple python interpreters so that you can test in all theenvironments listed intox.ini
or you will have to runtox
with the-e
flag to run only in your version of python. For example, if you onlyhave Python 2.7 thentox -e py27
will limit your test run to Python 2.7.
- Researchopen issues
- Follow thecontribution 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 previousfour releases ofvSphere and it's own previous four releases.Compatibility with much older versions may continue to work but willnot be actively supported.
For example, version v6.0.0 is most compatible with vSphere 6.0, 5.5, 5.1 and5.0. Initial releases compatible with a version of vSphere will bare a nakedversion number of v6.0.0 indicating that version of pyVmomi was releasedsimultaneously with theGA version of vSphere with the same version number.
Support details can be referenced under theSDK and API Support for Commercial and Enterprise Organizations section atBroadcom Developer Portal.
For community support, please open aGithub issue or start aDiscussion.
- 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!
About
VMware vSphere API Python Bindings