Class: Ansible::Ruby::Modules::One_vm

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::One_vm

Defined in:

lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb

Overview

Manages OpenNebula instances

Instance Method Summary

• #api_password ⇒ Object^?

  Password of the user to login into OpenNebula RPC server.

• #api_url ⇒ Object^?

  URL of the OpenNebula RPC server.,It is recommended to use HTTPS so that the username/password are not,transferred over the network unencrypted.,If not set then the value of the C(ONE_URL) environment variable is used.

• #api_username ⇒ Object^?

  Name of the user to login into the OpenNebula RPC server.

• #attributes ⇒ Object^?

  A dictionary of key/value attributes to add to new instances, or for,setting C(state) of instances with these attributes.,Keys are case insensitive and OpenNebula automatically converts them to upper case.,Be aware C(NAME) is a special attribute which sets the name of the VM when it’s deployed.,C(#) character(s) can be appended to the C(NAME) and the module will automatically add,indexes to the names of VMs.,For example’:‘ C(NAME’:‘ foo-###) would create VMs with names C(foo-000), C(foo-001),…,When used with C(count_attributes) and C(exact_count) the module will,match the base name without the index part.

• #count ⇒ Integer^?

  Number of instances to launch.

• #count_attributes ⇒ Hash^?

  A dictionary of key/value attributes that can only be used with,C(exact_count) to determine how many nodes based on a specific,attributes criteria should be deployed.

• #count_labels ⇒ Array<String>, ...

  A list of labels that can only be used with C(exact_count) to determine,how many nodes based on a specific labels criteria should be deployed.,This can be expressed in multiple ways and is shown in the EXAMPLES,section.

• #cpu ⇒ Object^?

  Percentage of CPU divided by 100 required for the new instance.

• #disk_saveas ⇒ Hash^?

  Creates an image from a VM disk.,It is a dictionary where you have to specife C(name) of the new image.,Optionally you can specife C(disk_id) of the disk you want to save.

• #disk_size ⇒ String^?

  The size of the disk created for new instances (in MB, GB, TB,…).,NOTE’:‘ This option can be used only if the VM template specified with,C(template_id)/C(template_name) has exactly one disk.

• #exact_count ⇒ Integer^?

  Indicates how many instances that match C(count_attributes) and,C(count_labels) parameters should be deployed.

• #group_id ⇒ Integer^?

  ID of the group which will be set as the group of the instance.

• #hard ⇒ Symbol^?

  Reboot, power-off or terminate instances C(hard).

• #instance_ids ⇒ Array<Integer>, ...

  A list of instance ids used for states’:‘ C(absent), C(running), C(rebooted), C(poweredoff).

• #labels ⇒ Object^?

  A list of labels to associate with new instances, or for setting,C(state) of instances with these labels.

• #memory ⇒ String^?

  The size of the memory for new instances (in MB, GB, …).

• #mode ⇒ Integer^?

  Set permission mode of the instance in octet format, e.g.

• #networks ⇒ Object^?

  A list of dictionaries with network parameters.

• #owner_id ⇒ Object^?

  ID of the user which will be set as the owner of the instance.

• #state ⇒ :present, ...

  C(present) - create instances from a template specified with C(template_id)/C(template_name).,C(running) - run instances,C(poweredoff) - power-off instances,C(rebooted) - reboot instances,C(absent) - terminate instances.

• #template_id ⇒ Integer^?

  ID of a VM template to use to create a new instance.

• #template_name ⇒ String^?

  Name of VM template to use to create a new instace.

• #vcpu ⇒ Integer^?

  Number of CPUs (cores) new VM will have.

• #wait ⇒ Boolean^?

  Wait for the instance to reach its desired state before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#api_password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 18

attribute :api_password

#api_url ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 12

attribute :api_url

#api_username ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 15

attribute :api_username

#attributes ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 49

attribute :attributes

#count ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 63

attribute :count

#count_attributes ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 55

attribute :count_attributes

#count_labels ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 59

attribute :count_labels

#cpu ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 90

attribute :cpu

#disk_saveas ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 100

attribute :disk_saveas

#disk_size ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 86

attribute :disk_size

#exact_count ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 67

attribute :exact_count

#group_id ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 78

attribute :group_id

#hard ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 37

attribute :hard

#instance_ids ⇒ Array<Integer>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 29

attribute :instance_ids

#labels ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 52

attribute :labels

#memory ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 82

attribute :memory

#mode ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 71

attribute :mode

#networks ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 97

attribute :networks

#owner_id ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 75

attribute :owner_id

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 33

attribute :state

#template_id ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 25

attribute :template_id

#template_name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 21

attribute :template_name

#vcpu ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 93

attribute :vcpu

#wait ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 41

attribute :wait

#wait_timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/opennebula/one_vm.rb', line 45

attribute :wait_timeout