Class: Ansible::Ruby::Modules::Rax

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb

Overview

creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be ‘running’.

Instance Method Summary

• #auto_increment ⇒ Boolean^?

  Whether or not to increment a single number with the name of the created servers.

• #boot_from_volume ⇒ :yes, ...

  Whether or not to boot the instance from a Cloud Block Storage volume.

• #boot_volume ⇒ Object^?

  Cloud Block Storage ID or Name to use as the boot volume of the instance.

• #boot_volume_size ⇒ Integer^?

  Size of the volume to create in Gigabytes.

• #boot_volume_terminate ⇒ Boolean^?

  Whether the I(boot_volume) or newly created volume from I(image) will be terminated when the server is terminated.

• #config_drive ⇒ Boolean^?

  Attach read-only configuration drive to server as label config-2.

• #count ⇒ Integer^?

  Number of instances to launch.

• #count_offset ⇒ Integer^?

  Number count to start at.

• #disk_config ⇒ :auto, ...

  Disk partitioning strategy.

• #exact_count ⇒ Boolean^?

  Explicitly ensure an exact count of instances, used with state=active/present.

• #extra_client_args ⇒ Object^?

  A hash of key/value pairs to be used when creating the cloudservers client.

• #extra_create_args ⇒ Object^?

  A hash of key/value pairs to be used when creating a new server.

• #files ⇒ Object^?

  Files to insert into the instance.

• #flavor ⇒ Object^?

  Flavor to use for the instance.

• #group ⇒ Object^?

  Host group to assign to server, is also used for idempotent operations to ensure a specific number of instances.

• #image ⇒ Object^?

  Image to use for the instance.

• #instance_ids ⇒ Object^?

  List of instance ids, currently only used when state=‘absent’ to remove instances.

• #key_name ⇒ Object^?

  Key pair to use on the instance.

• #meta ⇒ Object^?

  A hash of metadata to associate with the instance.

• #name ⇒ String^?

  Name to give the instance.

• #networks ⇒ String^?

  The network to attach to the instances.

• #state ⇒ :present, ...

  Indicate desired state of the resource.

• #user_data ⇒ Object^?

  Data to be uploaded to the servers config drive.

• #wait ⇒ :yes, ...

  Wait for the instance to be in state ‘running’ 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#auto_increment ⇒ Boolean^?

Returns Whether or not to increment a single number with the name of the created servers. Only applicable when used with the I(group) attribute or meta key.

Returns:

• (Boolean, nil) —

  Whether or not to increment a single number with the name of the created servers. Only applicable when used with the I(group) attribute or meta key.

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

attribute :auto_increment

#boot_from_volume ⇒ :yes, ...

Returns Whether or not to boot the instance from a Cloud Block Storage volume. If C(yes) and I(image) is specified a new volume will be created at boot time. I(boot_volume_size) is required with I(image) to create a new volume at boot time.

Returns:

• (:yes, :no, nil) —

  Whether or not to boot the instance from a Cloud Block Storage volume. If C(yes) and I(image) is specified a new volume will be created at boot time. I(boot_volume_size) is required with I(image) to create a new volume at boot time.

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

attribute :boot_from_volume

#boot_volume ⇒ Object^?

Returns Cloud Block Storage ID or Name to use as the boot volume of the instance.

Returns:

• (Object, nil) —

  Cloud Block Storage ID or Name to use as the boot volume of the instance

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

attribute :boot_volume

#boot_volume_size ⇒ Integer^?

Returns Size of the volume to create in Gigabytes. This is only required with I(image) and I(boot_from_volume).

Returns:

• (Integer, nil) —

  Size of the volume to create in Gigabytes. This is only required with I(image) and I(boot_from_volume).

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

attribute :boot_volume_size

#boot_volume_terminate ⇒ Boolean^?

Returns Whether the I(boot_volume) or newly created volume from I(image) will be terminated when the server is terminated.

Returns:

• (Boolean, nil) —

  Whether the I(boot_volume) or newly created volume from I(image) will be terminated when the server is terminated

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

attribute :boot_volume_terminate

#config_drive ⇒ Boolean^?

Returns Attach read-only configuration drive to server as label config-2.

Returns:

• (Boolean, nil) —

  Attach read-only configuration drive to server as label config-2

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

attribute :config_drive

#count ⇒ Integer^?

Returns number of instances to launch.

Returns:

• (Integer, nil) —

  number of instances to launch

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

attribute :count

#count_offset ⇒ Integer^?

Returns number count to start at.

Returns:

• (Integer, nil) —

  number count to start at

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

attribute :count_offset

#disk_config ⇒ :auto, ...

Returns Disk partitioning strategy.

Returns:

• (:auto, :manual, nil) —

  Disk partitioning strategy

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

attribute :disk_config

#exact_count ⇒ Boolean^?

Returns Explicitly ensure an exact count of instances, used with state=active/present. If specified as C(yes) and I(count) is less than the servers matched, servers will be deleted to match the count. If the number of matched servers is fewer than specified in I(count) additional servers will be added.

Returns:

• (Boolean, nil) —

  Explicitly ensure an exact count of instances, used with state=active/present. If specified as C(yes) and I(count) is less than the servers matched, servers will be deleted to match the count. If the number of matched servers is fewer than specified in I(count) additional servers will be added.

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

attribute :exact_count

#extra_client_args ⇒ Object^?

Returns A hash of key/value pairs to be used when creating the cloudservers client. This is considered an advanced option, use it wisely and with caution.

Returns:

• (Object, nil) —

  A hash of key/value pairs to be used when creating the cloudservers client. This is considered an advanced option, use it wisely and with caution.

# File 'lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb', line 50

attribute :extra_client_args

#extra_create_args ⇒ Object^?

Returns A hash of key/value pairs to be used when creating a new server. This is considered an advanced option, use it wisely and with caution.

Returns:

• (Object, nil) —

  A hash of key/value pairs to be used when creating a new server. This is considered an advanced option, use it wisely and with caution.

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

attribute :extra_create_args

#files ⇒ Object^?

Returns Files to insert into the instance. remotefilename:localcontent.

Returns:

• (Object, nil) —

  Files to insert into the instance. remotefilename:localcontent

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

attribute :files

#flavor ⇒ Object^?

Returns flavor to use for the instance.

Returns:

• (Object, nil) —

  flavor to use for the instance

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

attribute :flavor

#group ⇒ Object^?

Returns host group to assign to server, is also used for idempotent operations to ensure a specific number of instances.

Returns:

• (Object, nil) —

  host group to assign to server, is also used for idempotent operations to ensure a specific number of instances

# File 'lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb', line 62

attribute :group

#image ⇒ Object^?

Returns image to use for the instance. Can be an C(id), C(human_id) or C(name). With I(boot_from_volume), a Cloud Block Storage volume will be created with this image.

Returns:

• (Object, nil) —

  image to use for the instance. Can be an C(id), C(human_id) or C(name). With I(boot_from_volume), a Cloud Block Storage volume will be created with this image

# File 'lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb', line 65

attribute :image

#instance_ids ⇒ Object^?

Returns list of instance ids, currently only used when state=‘absent’ to remove instances.

Returns:

• (Object, nil) —

  list of instance ids, currently only used when state=‘absent’ to remove instances

# File 'lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb', line 68

attribute :instance_ids

#key_name ⇒ Object^?

Returns key pair to use on the instance.

Returns:

• (Object, nil) —

  key pair to use on the instance

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

attribute :key_name

#meta ⇒ Object^?

Returns A hash of metadata to associate with the instance.

Returns:

• (Object, nil) —

  A hash of metadata to associate with the instance

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

attribute :meta

#name ⇒ String^?

Returns Name to give the instance.

Returns:

• (String, nil) —

  Name to give the instance

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

attribute :name

#networks ⇒ String^?

Returns The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be C(id) or C(label).

Returns:

• (String, nil) —

  The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be C(id) or C(label).

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

attribute :networks

#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/rackspace/rax.rb', line 85

attribute :state

#user_data ⇒ Object^?

Returns Data to be uploaded to the servers config drive. This option implies I(config_drive). Can be a file path or a string.

Returns:

• (Object, nil) —

  Data to be uploaded to the servers config drive. This option implies I(config_drive). Can be a file path or a string

# File 'lib/ansible/ruby/modules/generated/core/cloud/rackspace/rax.rb', line 89

attribute :user_data

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

• (:yes, :no, nil) —

  wait for the instance to be in state ‘running’ before returning

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

attribute :wait

#wait_timeout ⇒ Integer^?

Returns how long before wait gives up, in seconds.

Returns:

• (Integer, nil) —

  how long before wait gives up, in seconds

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

attribute :wait_timeout