community.vmware.vca_vapp – Manages vCloud Air vApp instances.
Note
This plugin is part of the community.vmware collection (version 1.17.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vca_vapp
.
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Module depends upon deprecated version of Pyvcloud library.
- Alternative
Use https://github.com/vmware/ansible-module-vcloud-director instead.
Synopsis
This module will actively managed vCloud Air vApp instances. Instances can be created and deleted as well as both deployed and undeployed.
Requirements
The below requirements are needed on the host that executes this module.
pyvcloud <= 18.2.2
Parameters
Parameter |
Comments |
---|---|
The api version to be used with the vca Default: “5.7” |
|
The name of the gateway of the vdc where the rule should be added. Default: “gateway” |
|
The authentication host to be used when service type is vcd. |
|
The instance id in a vchs environment to be used for creating the vapp |
|
Configures the mode of the network connection. Choices:
|
|
The name of the network that should be attached to the virtual machine in the vApp. The virtual network specified must already be created in the vCloud Air VDC. If the state is not ‘absent’ then the network_name argument must be provided. |
|
Specifies an operation to be performed on the vApp. Choices:
|
|
The org to login to for creating vapp, mostly set when the service_type is vdc. |
|
The vCloud Air password to use during authentication |
|
The type of service we are authenticating against Choices:
|
|
Configures the state of the vApp. Choices:
|
|
The name of the vApp template to use to create the vApp instance. If the state is not absent then the template_name value must be provided. The template_name must be previously uploaded to the catalog specified by catalog_name |
|
The vCloud Air username to use during authentication |
|
If the certificates of the authentication is to be verified. Choices:
|
|
The name of the vCloud Air vApp instance |
|
The name of the virtual data center (VDC) where the vm should be created or contains the vAPP. |
|
The number of vCPUs to configure for the VM in the vApp. If the vm_name argument is provided, then this becomes a per VM setting otherwise it is applied to all VMs in the vApp. |
|
The amount of memory in MB to allocate to VMs in the vApp. If the vm_name argument is provided, then this becomes a per VM setting otherwise it is applied to all VMs in the vApp. |
|
The name of the virtual machine instance in the vApp to manage. |
Notes
Note
VMware sold their vCloud Air service in Q2 2017.
VMware made significant changes to the pyvcloud interface around this time. The
vca_vapp
module relies on now deprecated code.Mileage with
vca_vapp
may vary as vCloud Director APIs advance.A viable alternative maybe https://github.com/vmware/ansible-module-vcloud-director
Examples
- name: Creates a new vApp in a VCA instance
community.vmware.vca_vapp:
vapp_name: tower
state: present
template_name: 'Ubuntu Server 12.04 LTS (amd64 20150127)'
vdc_name: VDC1
instance_id: '<your instance id here>'
username: '<your username here>'
password: '<your password here>'
delegate_to: localhost
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Peter Sprygada (@privateip)