ansible.builtin.vca_vapp (v2.3.3.0-1) — module

Manages vCloud Air vApp instances.

| "added in version" 2.0 of ansible.builtin"

Authors: Peter Sprygada (@privateip)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

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

Usage examples

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

- name: Creates a new vApp in a VCA instance
  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>'

Inputs

    
org:
    default: None
    description:
    - The org to login to for creating vapp, mostly set when the service_type is vdc.
    required: false

host:
    default: None
    description:
    - The authentication host to be used when service type  is vcd.
    required: false

state:
    choices:
    - present
    - absent
    - deployed
    - undeployed
    default: present
    description:
    - Configures the state of the vApp.
    required: false

vm_cpus:
    default: None
    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.
    required: false

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

password:
    default: None
    description:
    - The vCloud Air password to use during authentication
    required: false

username:
    default: None
    description:
    - The vCloud Air username to use during authentication
    required: false

vdc_name:
    default: None
    description:
    - The name of the virtual data center (VDC) where the vm should be created or contains
      the vAPP.
    required: false

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

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

vm_memory:
    default: None
    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 otherise it is applied to all VMs
      in the vApp.
    required: false

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

instance_id:
    default: None
    description:
    - The instance id in a vchs environment to be used for creating the vapp
    required: false

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

network_name:
    default: None
    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.
    required: false

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

template_name:
    default: None
    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)
    required: false