Class: Ansible::Ruby::Modules::Os_server

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb

Overview

Create or Remove compute instances from OpenStack.

Instance Method Summary

• #auto_ip ⇒ :yes, ...

  Ensure instance has public ip however the cloud wants to do that.

• #availability_zone ⇒ Object^?

  Availability zone in which to create the server.

• #boot_from_volume ⇒ :yes, ...

  Should the instance boot from a persistent volume created based on the image given.

• #boot_volume ⇒ Object^?

  Volume name or id to use as the volume to boot from.

• #config_drive ⇒ :yes, ...

  Whether to boot the server with config drive enabled.

• #delete_fip ⇒ :yes, ...

  When I(state) is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance.

• #flavor ⇒ Integer^?

  The name or id of the flavor in which the new instance 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 instance has to be created must have.

• #floating_ip_pools ⇒ Object^?

  Name of floating IP pool from which to choose a floating IP.

• #floating_ips ⇒ Object^?

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

• #image ⇒ String

  The name or id of the base image to boot.

• #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.

• #key_name ⇒ String^?

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

• #meta ⇒ Hash, ...

  A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs.

• #name ⇒ String

  Name that has to be given to the instance.

• #network ⇒ String^?

  Name or ID of a network to attach this instance to.

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

  A list of networks to which the instance’s interface should be attached.

• #reuse_ips ⇒ :yes, ...

  When I(auto_ip) is true and this option is true, the I(auto_ip) code will attempt to re-use unassigned floating ips in the project before creating a new one.

• #scheduler_hints ⇒ Object^?

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

• #security_groups ⇒ Object^?

  Names of the security groups to which the instance should be added.

• #state ⇒ :present, ...

  Should the resource be present or absent.

• #terminate_volume ⇒ :yes, ...

  If C(yes), delete volume when deleting instance (if booted from volume).

• #timeout ⇒ Integer^?

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

• #userdata ⇒ Object^?

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

• #volume_size ⇒ Object^?

  The size of the volume to create in GB if booting from volume based on an image.

• #volumes ⇒ Object^?

  A list of preexisting volumes names or ids to attach to the instance.

• #wait ⇒ :yes, ...

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

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

#auto_ip ⇒ :yes, ...

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

attribute :auto_ip

#availability_zone ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 110

attribute :availability_zone

#boot_from_volume ⇒ :yes, ...

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

attribute :boot_from_volume

#boot_volume ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 85

attribute :boot_volume

#config_drive ⇒ :yes, ...

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

attribute :config_drive

#delete_fip ⇒ :yes, ...

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

attribute :delete_fip

#flavor ⇒ Integer^?

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

attribute :flavor

#flavor_include ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 31

attribute :flavor_include

#flavor_ram ⇒ Integer^?

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

attribute :flavor_ram

#floating_ip_pools ⇒ Object^?

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

attribute :floating_ip_pools

#floating_ips ⇒ Object^?

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

attribute :floating_ips

#image ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 16

attribute :image

#image_exclude ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 20

attribute :image_exclude

#key_name ⇒ String^?

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

attribute :key_name

#meta ⇒ Hash, ...

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

attribute :meta

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 12

attribute :name

#network ⇒ String^?

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

attribute :network

#nics ⇒ Array<Hash>, ...

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

attribute :nics

#reuse_ips ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 106

attribute :reuse_ips

#scheduler_hints ⇒ Object^?

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

attribute :scheduler_hints

#security_groups ⇒ Object^?

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

attribute :security_groups

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 98

attribute :state

#terminate_volume ⇒ :yes, ...

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

attribute :terminate_volume

#timeout ⇒ Integer^?

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

attribute :timeout

#userdata ⇒ Object^?

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

attribute :userdata

#volume_size ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 82

attribute :volume_size

#volumes ⇒ Object^?

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

attribute :volumes

#wait ⇒ :yes, ...

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

attribute :wait