Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.rax.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_key string | Rackspace API key, overrides credentials. aliases: password | |
| auth_endpoint string | The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/
| |
| auto_increment boolean |
| Whether or not to increment a single number with the name of the created servers. Only applicable when used with the group attribute or meta key. |
| boot_from_volume boolean |
| Whether or not to boot the instance from a Cloud Block Storage volume. If yes and image is specified a new volume will be created at boot time. boot_volume_size is required with image to create a new volume at boot time. |
| boot_volume string | Cloud Block Storage ID or Name to use as the boot volume of the instance | |
| boot_volume_size integer | Default: 100 | Size of the volume to create in Gigabytes. This is only required with image and boot_from_volume. |
| boot_volume_terminate boolean |
| Whether the boot_volume or newly created volume from 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 | Default: 1 | number of instances to launch |
| count_offset integer | Default: 1 | number count to start at |
| credentials path | File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file | |
| disk_config string |
| Disk partitioning strategy If not specified it will assume the value auto. |
| env string | Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| exact_count boolean |
| Explicitly ensure an exact count of instances, used with state=active/present. If specified as yes and 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 count additional servers will be added. |
| extra_client_args dictionary | 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. | |
| extra_create_args dictionary | 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. | |
| files dictionary | Files to insert into the instance. remotefilename:localcontent | |
| flavor string | flavor to use for the instance | |
| group string | host group to assign to server, is also used for idempotent operations to ensure a specific number of instances | |
| identity_type string | Default: "rackspace" | Authentication mechanism to use, such as rackspace or keystone. |
| image string | image to use for the instance. Can be an id, human_id or name. With boot_from_volume, a Cloud Block Storage volume will be created with this image | |
| instance_ids list / elements=string | list of instance ids, currently only used when state='absent' to remove instances | |
| key_name string | key pair to use on the instance aliases: keypair | |
| meta dictionary | A hash of metadata to associate with the instance | |
| name string | Name to give the instance | |
| networks list / elements=string | Default: ["public", "private"] | The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be id or label. |
| region string | Region to create an instance in. | |
| state string |
| Indicate desired state of the resource |
| tenant_id string | The tenant ID used for authentication. | |
| tenant_name string | The tenant name used for authentication. | |
| user_data string | Data to be uploaded to the servers config drive. This option implies config_drive. Can be a file path or a string | |
| username string | Rackspace username, overrides credentials. | |
| validate_certs boolean |
| Whether or not to require SSL validation of API endpoints. aliases: verify_ssl |
| wait boolean |
| wait for the instance to be in state 'running' before returning |
| wait_timeout integer | Default: 300 | how long before wait gives up, in seconds |
Note
absent and the extra servers are deleted. In the case of deletion, the returned data structure will have action set to delete, and the oldest servers in the group will be deleted.RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
RAX_USERNAME and RAX_API_KEY obviate the use of a credentials fileRAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)- name: Build a Cloud Server
gather_facts: False
tasks:
- name: Server build request
local_action:
module: rax
credentials: ~/.raxpub
name: rax-test1
flavor: 5
image: b11d9567-e412-4255-96b9-bd63ab23bcfe
key_name: my_rackspace_key
files:
/root/test.txt: /home/localuser/test.txt
wait: yes
state: present
networks:
- private
- public
register: rax
- name: Build an exact count of cloud servers with incremented names
hosts: local
gather_facts: False
tasks:
- name: Server build requests
local_action:
module: rax
credentials: ~/.raxpub
name: test%03d.example.org
flavor: performance1-1
image: ubuntu-1204-lts-precise-pangolin
state: present
count: 10
count_offset: 10
exact_count: yes
group: test
wait: yes
register: rax
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/rax_module.html