ANSIBLE.RAX(3)                  ANSIBLE MODULES                 ANSIBLE.RAX(3)



NAME
       rax - create / delete an instance in Rackspace Public Cloud

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

OPTIONS
       api_key
              Rackspace API key (overrides credentials)

       count  number of instances to launch (default: yes(Added in Ansible
              version 1.4.)


       count_offset
              number count to start at (default: yes(Added in Ansible version
              1.4.)


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

       disk_config
              Disk partitioning strategy Choices: auto,manual. (default:
              auto)(Added in Ansible version 1.4.)


       exact_count
              Explicitly ensure an exact count of instances, used with
              state=active/present(Added in Ansible version 1.4.)


       files  Files to insert into the instance. remotefilename:localcontent

       flavor flavor to use for the instance

       group  host group to assign to server, is also used for idempotent
              operations to ensure a specific number of instances(Added in
              Ansible version 1.4.)


       image  image to use for the instance. Can be an id, human_id or name

       instance_ids
              list of instance ids, currently only used when state='absent' to
              remove instances(Added in Ansible version 1.4.)


       key_name
              key pair to use on the instance

       meta   A hash of metadata to associate with the instance

       name   Name to give the instance

       networks
              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. (default: ['public',
              'private'])(Added in Ansible version 1.4.)


       region Region to create an instance in (default: DFW)

       state  Indicate desired state of the resource Choices: present,absent.
              (default: present)

       username
              Rackspace username (overrides credentials)

       wait   wait for the instance to be in state 'running' before returning
              Choices: yes,no. (default: no)

       wait_timeout
              how long before wait gives up, in seconds (default: 300).

NOTES
       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 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
               files:
                 /root/.ssh/authorized_keys: /home/localuser/.ssh/id_rsa.pub
                 /root/test.txt: /home/localuser/test.txt
               wait: yes
               state: present
               networks:
                 - private
                 - public



AUTHOR
       Jesse Keating, Matt Martz

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#rax



1.4.5                             2014-02-12                    ANSIBLE.RAX(3)
