Class: Ansible::Ruby::Modules::Vca_vapp

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_version ⇒ String?

Returns The api version to be used with the vca.

Returns:

  • (String, nil) —

    The api version to be used with the vca



61
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 61

attribute :api_version

#host ⇒ Object?

Returns The authentication host to be used when service type is vcd.

Returns:

  • (Object, nil) —

    The authentication host to be used when service type is vcd.



58
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 58

attribute :host

#instance_id ⇒ String?

Returns The instance id in a vchs environment to be used for creating the vapp.

Returns:

  • (String, nil) —

    The instance id in a vchs environment to be used for creating the vapp



54
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 54

attribute :instance_id

#network_mode ⇒ :pool, ...

Returns Configures the mode of the network connection.

Returns:

  • (:pool, :dhcp, :static, nil) —

    Configures the mode of the network connection.



22
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 22

attribute :network_mode

#network_name ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 19

attribute :network_name

#operation ⇒ :noop, ...

Returns Specifies an operation to be performed on the vApp.

Returns:

  • (:noop, :poweron, :poweroff, :suspend, :shutdown, :reboot, :reset, nil) —

    Specifies an operation to be performed on the vApp.



35
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 35

attribute :operation

#org ⇒ Object?

Returns The org to login to for creating vapp, mostly set when the service_type is vdc.

Returns:

  • (Object, nil) —

    The org to login to for creating vapp, mostly set when the service_type is vdc.



51
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 51

attribute :org

#password ⇒ String?

Returns The vCloud Air password to use during authentication.

Returns:

  • (String, nil) —

    The vCloud Air password to use during authentication



47
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 47

attribute :password

#service_type ⇒ :vca, ...

Returns The type of service we are authenticating against.

Returns:

  • (:vca, :vchs, :vcd, nil) —

    The type of service we are authenticating against



65
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 65

attribute :service_type

#state ⇒ :present, ...

Returns Configures the state of the vApp.

Returns:

  • (:present, :absent, :deployed, :undeployed, nil) —

    Configures the state of the vApp.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 39

attribute :state

#template_name ⇒ String?

Returns 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).

Returns:

  • (String, nil) —

    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)



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 15

attribute :template_name

#username ⇒ String?

Returns The vCloud Air username to use during authentication.

Returns:

  • (String, nil) —

    The vCloud Air username to use during authentication



43
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 43

attribute :username

#vapp_name ⇒ String

Returns The name of the vCloud Air vApp instance.

Returns:

  • (String) —

    The name of the vCloud Air vApp instance



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 11

attribute :vapp_name

#vdc_name ⇒ String?

Returns The name of the virtual data center (VDC) where the vm should be created or contains the vAPP.

Returns:

  • (String, nil) —

    The name of the virtual data center (VDC) where the vm should be created or contains the vAPP.



69
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 69

attribute :vdc_name

#vm_cpus ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



29
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 29

attribute :vm_cpus

#vm_memory ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



32
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 32

attribute :vm_memory

#vm_name ⇒ Object?

Returns The name of the virtual machine instance in the vApp to manage.

Returns:

  • (Object, nil) —

    The name of the virtual machine instance in the vApp to manage.



26
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/vmware/vca_vapp.rb', line 26

attribute :vm_name