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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/openstack/nova_compute.rb

Overview

Create or Remove virtual machines from Openstack.

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

#auth_url ⇒ String?

Returns The keystone url for authentication.

Returns:

  • (String, nil) —

    The keystone url for authentication



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

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



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

attribute :auto_floating_ip

#availability_zone ⇒ Object?

Returns Name of the availability zone.

Returns:

  • (Object, nil) —

    Name of the availability zone



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

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



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

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



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

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.



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

attribute :key_name

#login_password ⇒ String

Returns Password of login user.

Returns:

  • (String) —

    Password of login user



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

attribute :login_password

#login_tenant_name ⇒ String

Returns The tenant name of the login user.

Returns:

  • (String) —

    The tenant name of the login user



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

attribute :login_tenant_name

#login_username ⇒ String

Returns login username to authenticate to keystone.

Returns:

  • (String) —

    login username to authenticate to keystone



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

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



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

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



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

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



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

attribute :nics

#region_name ⇒ Object?

Returns Name of the region.

Returns:

  • (Object, nil) —

    Name of the region



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

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



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

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



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

attribute :security_groups

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the resource



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

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



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

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.



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

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



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

attribute :wait_for