Documentation

rax_queue - create / delete a queue in Rackspace Public Cloud

New in version 1.5.

Synopsis

creates / deletes a Rackspace Public Cloud queue.

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
api_key
 no
    Rackspace API key (overrides credentials)

    aliases: password
    credentials
    		 no
      File to find the Rackspace credentials in (ignored if api_key and username are provided)

      aliases: creds_file
      env
      (added in 1.5)
      		 no
        name
        		 no
          Name to give the queue
          region
          		 no DFW
            Region to create an instance in
            state
            		 no present
            • present
            • absent
            Indicate desired state of the resource
            username
            		 no
              Rackspace username (overrides credentials)
              verify_ssl
              (added in 1.5)
              		 no
                Whether or not to require SSL validation of API endpoints

                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

                Notes

                Note

                The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

                Note

                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

                Note

                RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

                Note

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

                This is a Core Module

                For more information on what this means please read Core Modules

                For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.