rax_queue – create / delete a queue in Rackspace Public Cloud

Synopsis

• creates / deletes a Rackspace Public Cloud queue.

Requirements

The below requirements are needed on the host that executes this module.

• pyrax

• python >= 2.6

Parameters

Parameter	Choices/Defaults	Comments
api_key string		Rackspace API key, overrides credentials. aliases: password
auth_endpoint -	Default: "https://identity.api.rackspacecloud.com/v2.0/"	The URI of the authentication service.
credentials path		File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file
env string		Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type -	Default: "rackspace"	Authentication mechanism to use, such as rackspace or keystone.
name -		Name to give the queue
region string	Default: "DFW"	Region to create an instance in.
state -	Choices: present ← absent	Indicate desired state of the resource
tenant_id -		The tenant ID used for authentication.
tenant_name -		The tenant name used for authentication.
username string		Rackspace username, overrides credentials.
validate_certs boolean	Choices: no yes	Whether or not to require SSL validation of API endpoints. aliases: verify_ssl

Notes

Note

• The following environment variables can be used, 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 file

• RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

• The following environment variables can be used, 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 file

• RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

- name: Build a Queue
  gather_facts: False
  hosts: local
  connection: local
  tasks:
    - name: Queue create request
      local_action:
        module: rax_queue
        credentials: ~/.raxpub
        name: my-queue
        region: DFW
        state: present
      register: my_queue

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Christopher H. Laco (@claco)

• Matt Martz (@sivel)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.