community.vmware.vca_vapp (2.10.4) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==2.10.4

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 2.10.4

Description

This module will actively managed vCloud Air vApp instances. Instances can be created and deleted as well as both deployed and undeployed.

Requirements

• pyvcloud <= 18.2.2

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
org:
    description:
    - The org to login to for creating vapp, mostly set when the service_type is vdc.
    type: str

host:
    description:
    - The authentication host to be used when service type  is vcd.
    type: str

state:
    choices:
    - present
    - absent
    - deployed
    - undeployed
    default: present
    description:
    - Configures the state of the vApp.
    type: str

vm_cpus:
    description:
    - The number of vCPUs to configure for the VM in the vApp.   If the I(vm_name) argument
      is provided, then this becomes a per VM setting otherwise it is applied to all VMs
      in the vApp.

vm_name:
    description:
    - The name of the virtual machine instance in the vApp to manage.

password:
    aliases:
    - pass
    - passwd
    description:
    - The vCloud Air password to use during authentication
    type: str

username:
    aliases:
    - user
    description:
    - The vCloud Air username to use during authentication
    type: str

vdc_name:
    description:
    - The name of the virtual data center (VDC) where the vm should be created or contains
      the vAPP.
    type: str

operation:
    choices:
    - noop
    - poweron
    - poweroff
    - suspend
    - shutdown
    - reboot
    - reset
    default: noop
    description:
    - Specifies an operation to be performed on the vApp.

vapp_name:
    description:
    - The name of the vCloud Air vApp instance
    required: true

vm_memory:
    description:
    - The amount of memory in MB to allocate to VMs in the vApp.  If the I(vm_name) argument
      is provided, then this becomes a per VM setting otherwise it is applied to all VMs
      in the vApp.

api_version:
    default: '5.7'
    description:
    - The api version to be used with the vca
    type: str

instance_id:
    description:
    - The instance id in a vchs environment to be used for creating the vapp
    type: str

gateway_name:
    default: gateway
    description:
    - The name of the gateway of the vdc where the rule should be added.
    type: str

network_mode:
    choices:
    - pool
    - dhcp
    - static
    default: pool
    description:
    - Configures the mode of the network connection.

network_name:
    description:
    - 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
      I(state) is not 'absent' then the I(network_name) argument must be provided.

service_type:
    choices:
    - vca
    - vchs
    - vcd
    default: vca
    description:
    - The type of service we are authenticating against
    type: str

template_name:
    description:
    - The name of the vApp template to use to create the vApp instance.  If the I(state)
      is not `absent` then the I(template_name) value must be provided.  The I(template_name)
      must be previously uploaded to the catalog specified by I(catalog_name)

validate_certs:
    aliases:
    - verify_certs
    default: true
    description:
    - If the certificates of the authentication is to be verified.
    type: bool