https://github.com/vmware/pyvmomi

VMware vSphere API Python Bindings
https://github.com/vmware/pyvmomi

Last synced: about 2 months ago
JSON representation

VMware vSphere API Python Bindings

• Host: GitHub
• URL: https://github.com/vmware/pyvmomi
• Owner: vmware
• License: apache-2.0
• Created: 2013-12-13T17:30:30.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T07:59:22.000Z (about 2 months ago)
• Last Synced: 2024-07-31T09:13:31.856Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 5.05 MB
• Stars: 2,198
• Watchers: 187
• Forks: 766
• Open Issues: 295
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
pyvmomi

------------

.. |downloads| image:: https://img.shields.io/pypi/dm/pyvmomi.svg

    :target: https://pypi.python.org/pypi/pyvmomi/

.. |py-version| image:: https://img.shields.io/pypi/pyversions/pyVmomi

|downloads| |py-version|

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 `_.

.. contents:: Table of Contents

   :depth: 1

   :local:

   :backlinks: none

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

* To install the version in `github `_ use

  ``python setup.py develop`` for development install or

  ``python setup.py install``.

* To install `github's version `_ with sso support, just run

  ``pip install -e ".[sso]"`` inside project's home folder.

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 2.7 then ``tox -e py27`` will limit your test run to Python 2.7.

Contributing

============

* Research `open issues `_

* Follow the `contribution standards `_

Documentation

=============

For general language neutral documentation of vSphere Management API see:

* `Release Notes `_

* `vSphere Web Services API Doc `_

Python Support

==============

* pyVmomi supports Python 3.4+

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

====================

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 `_.

Related Projects

================

* 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!