Ansible Collection: community.vmware

This repo hosts the community.vmware Ansible Collection.

The collection includes the VMware modules and plugins supported by Ansible VMware community to help the management of VMware infrastructure.

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.

Installation and Usage

Installing the Collection from Ansible Galaxy

Before using the VMware community collection, you need to install the collection with the ansible-galaxy CLI:

ansible-galaxy collection install community.vmware

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: community.vmware

Required Python libraries

VMware community collection depends upon following third party libraries:

• Pyvmomi >= 6.7.1.2018.12
• vSphere Automation SDK for Python

Installing required libraries and SDK

Installing collection does not install any required third party Python libraries or SDKs. You need to install the required Python libraries using following command:

pip install -r ~/.ansible/collections/ansible_collections/community/vmware/requirements.txt

If you are working on developing and/or testing VMware community collection, you may want to install additional requirements using following command:

pip install -r ~/.ansible/collections/ansible_collections/community/vmware/test-requirements.txt

Included content

Connection plugins

Httpapi plugins

Inventory plugins

Modules

Testing and Development

If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATHS, and work on it there.

• Guidelines for VMware module development

Testing with ansible-test

Refer testing for more information.

Publishing New Version

Prepare the release:

• Refresh the README.md: tox -e add_docs
• Refresh the changelog: tox -e antsibull-changelog -- release --verbose --version 1.2.0
• Clean up the changelog fragments.
• Commit everything and push a PR for review

Push the release:

• Tag the release: git tag -s 1.0.0
• Push the tag: git push origin 1.0.

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.