Documentation

vca_vapp - Manages vCloud Air vApp instances.

New in version 2.0.

Synopsis

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

Options

parameter required default choices comments
api_version
 no 5.7
    The api version to be used with the vca
    host
    		 no None
      The authentication host to be used when service type is vcd.
      instance_id
      		 no None
        The instance id in a vchs environment to be used for creating the vapp
        network_mode
        		 no pool
        • pool
        • dhcp
        • static
        Configures the mode of the network connection.
        network_name
        		 no None
          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.
          operation
          		 no noop
          • noop
          • poweron
          • poweroff
          • suspend
          • shutdown
          • reboot
          • reset
          Specifies an operation to be performed on the vApp.
          org
          		 no None
            The org to login to for creating vapp, mostly set when the service_type is vdc.
            password
            		 no None
              The vCloud Air password to use during authentication
              service_type
              		 no vca
              • vca
              • vchs
              • vcd
              The type of service we are authenticating against
              state
              		 no present
              • present
              • absent
              • deployed
              • undeployed
              Configures the state of the vApp.
              template_name
              		 no None
                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
                username
                		 no None
                  The vCloud Air username to use during authentication
                  vapp_name
                  		 yes
                    The name of the vCloud Air vApp instance
                    vdc_name
                    		 no None
                      The name of the virtual data center (VDC) where the vm should be created or contains the vAPP.
                      vm_cpus
                      		 no None
                        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.
                        vm_memory
                        		 no None
                          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 otherise it is applied to all VMs in the vApp.
                          vm_name
                          		 no None
                            The name of the virtual machine instance in the vApp to manage.

                            Examples

                            - 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>

                            This is an Extras Module

                            For more information on what this means please read Extras Modules

                            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.