Class: Ansible::Ruby::Modules::Nova_compute

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb

Instance Method Summary

• #auth_url ⇒ String^?

  The keystone url for authentication.

• #auto_floating_ip ⇒ String^?

  Should a floating ip be auto created and assigned.

• #availability_zone ⇒ Object^?

  Name of the availability zone.

• #config_drive ⇒ String^?

  Whether to boot the server with config drive enabled.

• #flavor_id ⇒ Integer^?

  The id of the flavor in which the new VM has to be created.

• #flavor_include ⇒ Object^?

  Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count.

• #flavor_ram ⇒ Integer^?

  The minimum amount of ram in MB that the flavor in which the new VM has to be created must have.

• #floating_ip_pools ⇒ Object^?

  List of floating IP pools from which to choose a floating IP.

• #floating_ips ⇒ Object^?

  List of valid floating IPs that pre-exist to assign to this node.

• #image_exclude ⇒ Object^?

  Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions.

• #image_id ⇒ String

  The id of the base image to boot.

• #image_name ⇒ Object

  The name of the base image to boot.

• #key_name ⇒ String^?

  The key pair name to be used when creating a VM.

• #login_password ⇒ String

  Password of login user.

• #login_tenant_name ⇒ String

  The tenant name of the login user.

• #login_username ⇒ String

  Login username to authenticate to keystone.

• #meta ⇒ Hash^?

  A list of key value pairs that should be provided as a metadata to the new VM.

• #name ⇒ String

  Name that has to be given to the instance.

• #nics ⇒ Array<Hash>, ...

  A list of network id’s to which the VM’s interface should be attached.

• #region_name ⇒ Object^?

  Name of the region.

• #scheduler_hints ⇒ Object^?

  Arbitrary key/value pairs to the scheduler for custom use.

• #security_groups ⇒ Object^?

  The name of the security group to which the VM should be added.

• #state ⇒ :present, ...

  Indicate desired state of the resource.

• #user_data ⇒ Object^?

  Opaque blob of data which is made available to the instance.

• #wait ⇒ String^?

  If the module should wait for the VM to be created.

• #wait_for ⇒ Integer^?

  The amount of time the module should wait for the VM to get into active state.

Methods inherited from Base

#to_h

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

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

Constructor Details

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

Instance Method Details

#auth_url ⇒ String^?

Returns The keystone url for authentication.

Returns:

• (String, nil) —

  The keystone url for authentication

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 22

attribute :auth_url

#auto_floating_ip ⇒ String^?

Returns Should a floating ip be auto created and assigned.

Returns:

• (String, nil) —

  Should a floating ip be auto created and assigned

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 70

attribute :auto_floating_ip

#availability_zone ⇒ Object^?

Returns Name of the availability zone.

Returns:

• (Object, nil) —

  Name of the availability zone

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 80

attribute :availability_zone

#config_drive ⇒ String^?

Returns Whether to boot the server with config drive enabled.

Returns:

• (String, nil) —

  Whether to boot the server with config drive enabled

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 95

attribute :config_drive

#flavor_id ⇒ Integer^?

Returns The id of the flavor in which the new VM has to be created. Mutually exclusive with flavor_ram.

Returns:

• (Integer, nil) —

  The id of the flavor in which the new VM has to be created. Mutually exclusive with flavor_ram

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 48

attribute :flavor_id

#flavor_include ⇒ Object^?

Returns Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor_include is a positive match filter - it must exist in the flavor name.

Returns:

• (Object, nil) —

  Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor_include is a positive match filter - it must exist in the flavor name.

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 56

attribute :flavor_include

#flavor_ram ⇒ Integer^?

Returns The minimum amount of ram in MB that the flavor in which the new VM has to be created must have. Mutually exclusive with flavor_id.

Returns:

• (Integer, nil) —

  The minimum amount of ram in MB that the flavor in which the new VM has to be created must have. Mutually exclusive with flavor_id

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 52

attribute :flavor_ram

#floating_ip_pools ⇒ Object^?

Returns list of floating IP pools from which to choose a floating IP.

Returns:

• (Object, nil) —

  list of floating IP pools from which to choose a floating IP

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 77

attribute :floating_ip_pools

#floating_ips ⇒ Object^?

Returns list of valid floating IPs that pre-exist to assign to this node.

Returns:

• (Object, nil) —

  list of valid floating IPs that pre-exist to assign to this node

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 74

attribute :floating_ips

#image_exclude ⇒ Object^?

Returns Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image_exclude is a negative match filter - it is text that may not exist in the image name. Defaults to “(deprecated)”.

Returns:

• (Object, nil) —

  Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image_exclude is a negative match filter - it is text that may not exist in the image name. Defaults to “(deprecated)”

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 45

attribute :image_exclude

#image_id ⇒ String

Returns The id of the base image to boot. Mutually exclusive with image_name.

Returns:

• (String) —

  The id of the base image to boot. Mutually exclusive with image_name

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 37

attribute :image_id

#image_name ⇒ Object

Returns The name of the base image to boot. Mutually exclusive with image_id.

Returns:

• (Object) —

  The name of the base image to boot. Mutually exclusive with image_id

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 41

attribute :image_name

#key_name ⇒ String^?

Returns The key pair name to be used when creating a VM.

Returns:

• (String, nil) —

  The key pair name to be used when creating a VM

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 59

attribute :key_name

#login_password ⇒ String

Returns Password of login user.

Returns:

• (String) —

  Password of login user

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 14

attribute :login_password

#login_tenant_name ⇒ String

Returns The tenant name of the login user.

Returns:

• (String) —

  The tenant name of the login user

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 18

attribute :login_tenant_name

#login_username ⇒ String

Returns login username to authenticate to keystone.

Returns:

• (String) —

  login username to authenticate to keystone

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 10

attribute :login_username

#meta ⇒ Hash^?

Returns A list of key value pairs that should be provided as a metadata to the new VM.

Returns:

• (Hash, nil) —

  A list of key value pairs that should be provided as a metadata to the new VM

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 83

attribute :meta

#name ⇒ String

Returns Name that has to be given to the instance.

Returns:

• (String) —

  Name that has to be given to the instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 33

attribute :name

#nics ⇒ Array<Hash>, ...

Returns A list of network id’s to which the VM’s interface should be attached.

Returns:

• (Array<Hash>, Hash, nil) —

  A list of network id’s to which the VM’s interface should be attached

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 66

attribute :nics

#region_name ⇒ Object^?

Returns Name of the region.

Returns:

• (Object, nil) —

  Name of the region

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 26

attribute :region_name

#scheduler_hints ⇒ Object^?

Returns Arbitrary key/value pairs to the scheduler for custom use.

Returns:

• (Object, nil) —

  Arbitrary key/value pairs to the scheduler for custom use

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 102

attribute :scheduler_hints

#security_groups ⇒ Object^?

Returns The name of the security group to which the VM should be added.

Returns:

• (Object, nil) —

  The name of the security group to which the VM should be added

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 63

attribute :security_groups

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

• (:present, :absent, nil) —

  Indicate desired state of the resource

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 29

attribute :state

#user_data ⇒ Object^?

Returns Opaque blob of data which is made available to the instance.

Returns:

• (Object, nil) —

  Opaque blob of data which is made available to the instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 99

attribute :user_data

#wait ⇒ String^?

Returns If the module should wait for the VM to be created.

Returns:

• (String, nil) —

  If the module should wait for the VM to be created.

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 87

attribute :wait

#wait_for ⇒ Integer^?

Returns The amount of time the module should wait for the VM to get into active state.

Returns:

• (Integer, nil) —

  The amount of time the module should wait for the VM to get into active state

# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb', line 91

attribute :wait_for