Ansible Collection: vmware.vmware_rest
This repo hosts the vmware.vmware_rest Ansible Collection.
The collection includes the VMware modules and plugins supported by Ansible VMware community to help the management of VMware infrastructure. These modules are different from community.vmware since they are based upon VMware vSphere REST API interface and not relying on any third party libraries such as Pyvmomi and vSphere Automation SDK for Python.
Ansible version compatibility
This collection has been tested against following Ansible versions: >=2.9.10.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.
Content
Modules
Installation and Usage
Install the dependencies
This collection depends on Python 3.6 or greater and aiohttp.
You can either install aiohttp using your OS package manager or using Python virtual environment.
Notes:
For RHEL, there is no python3-aiohttp package available (yet), you can either get it from EPEL or install aiohttp using pip.
Installing the Collection from Ansible Galaxy
Before using the VMware collection, you need to install the collection with the ansible-galaxy CLI:
ansible-galaxy collection install vmware.vmware_rest
You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:
collections:
- name: vmware.vmware_restDocumentation
The VMware REST modules guide gives a step by step introduction of the collection.
Testing and Development
Please, don't open Pull Request against the vmware_rest repository. We use a project called vmware_rest_code_generate to generate these modules and your change would be lost.
Testing with ansible-test
virtualenv -p python3.7 .virtualenv/py37 # Or any other version greater than 3.6
source .virtualenv/py37/bin/activate
pip install -r requirements.txt -r test-requirements.txt
ansible-test network-integration --python 3.7 --inventory /tmp/inventory-vmware_rest vcenter_vm_scenario1
Communication
We have a dedicated Working Group for VMware.
You can find other people interested in this in #ansible-vmware on Freenode IRC.
For more information about communities, meetings and agendas see https://github.com/ansible/community/wiki/VMware.
License
GNU General Public License v3.0 or later
See LICENSE to see the full text.