ansible-module-vcloud-director is a set of ansible modules to manage various operations on VMware vCloud Director.
- pip install --user pyvcloud
- git clone https://github.com/vmware/ansible-module-vcloud-director
- cd ansible-module-vcloud-director
- ansible-galaxy collection build
- ansible-galaxy collection install
- ansible-playbook -i playbooks/main.yml
This reposiroty packaged below two components to manage VCD,
- Ansible Modules
- Ansbile Playbooks
Ansible playbooks are the client which use modules as a gateway to interact with VCD. We have written various ansible playbooks to show how to interact with VCD. We are using ansible roles to define playbooks in modular fashion for each module. Please refer roles and main.yml to see usage.
These modules may be deployed in two ways,
We may define modules and module_utils settings in ansible.cfg to deploy ansible modules local to a directory. We have packaged ansible.cfg with this repository. You may refer this
We may copy modules and module_utils to below paths to deploy ansible modules globally.
/usr/share/ansible/plugins/modules//usr/share/ansible/plugins/module_utils
Refer docs to know more about available modules and their usage.
- vcd_catalog
- vcd_catalog_item
- vcd_disk
- vcd_external_network
- vcd_org
- vcd_org_vdc
- vcd_roles
- vcd_user
- vcd_vapp
- vcd_vapp_network
- vcd_vapp_vm
- vcd_vapp_vm_disk
- vcd_vapp_vm_nic
- vcd_vapp_vm_snapshot
- vcd_vdc_gateway
- vcd_vdc_network
- vcd_gateway_services
Following is the approx version matrix which are tested and supported through vCD ansible modules,
| vCD Version | API Versions |
|---|---|
| vCD 9.0 | 29.0 |
| vCD 9.1 | 30.0 |
| vCD 9.5 | 31.0 |
| vCD 9.7 | 32.0 |
| vCD 10.0 | 33.0 |
| vCD 10.1 | 34.0 |
Note - Testing is still in progress for new releases of vCD and Pyvcloud.
The ansible-module-vcloud-director project team welcomes contributions from the community. Before you start working with ansible-module-vcloud-director, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.