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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/rackspace/rax.rb

Overview

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

Instance Method Summary collapse

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_increment ⇒ :yes, ...

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:

  • (:yes, :no, 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.



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

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.



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

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



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

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



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

attribute :boot_volume_size

#boot_volume_terminate ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :boot_volume_terminate

#config_drive ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :config_drive

#count ⇒ Integer?

Returns number of instances to launch.

Returns:

  • (Integer, nil) —

    number of instances to launch



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

attribute :count

#count_offset ⇒ Integer?

Returns number count to start at.

Returns:

  • (Integer, nil) —

    number count to start at



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

attribute :count_offset

#disk_config ⇒ :auto, ...

Returns Disk partitioning strategy.

Returns:

  • (:auto, :manual, nil) —

    Disk partitioning strategy



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

attribute :disk_config

#exact_count ⇒ :yes, ...

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:

  • (:yes, :no, 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.



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

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.



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

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.



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

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



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

attribute :files

#flavor ⇒ Object?

Returns flavor to use for the instance.

Returns:

  • (Object, nil) —

    flavor to use for the instance



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

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



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

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



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

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



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

attribute :instance_ids

#key_name ⇒ Object?

Returns key pair to use on the instance.

Returns:

  • (Object, nil) —

    key pair to use on the instance



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

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



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

attribute :meta

#name ⇒ String?

Returns Name to give the instance.

Returns:

  • (String, nil) —

    Name to give the instance



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

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



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

attribute :networks

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the resource



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

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



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

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



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

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



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

attribute :wait_timeout