Documentation

rax_facts - Gather facts for Rackspace Cloud Servers

New in version 1.4.

Synopsis

Gather facts for Rackspace Cloud Servers.

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
address
 no
    Server IP address to retrieve facts for, will match any IP assigned to the server
    api_key
    		 no
      Rackspace API key (overrides credentials)

      aliases: password
      auth_endpoint
      (added in 1.5)
      		 no https://identity.api.rackspacecloud.com/v2.0/
        The URI of the authentication service
        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
            id
            		 no
              Server ID to retrieve facts for
              identity_type
              (added in 1.5)
              		 no rackspace
                Authentication machanism to use, such as rackspace or keystone
                name
                		 no
                  Server name to retrieve facts for
                  region
                  		 no DFW
                    Region to create an instance in
                    tenant_id
                    (added in 1.5)
                    		 no
                      The tenant ID used for authentication
                      tenant_name
                      (added in 1.5)
                      		 no
                        The tenant name used for authentication
                        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: Gather info about servers
  hosts: all
  gather_facts: False
  tasks:
    - name: Get facts about servers
      local_action:
        module: rax_facts
        credentials: ~/.raxpub
        name: "{{ inventory_hostname }}"
        region: DFW
    - name: Map some facts
      set_fact:
        ansible_ssh_host: "{{ rax_accessipv4 }}"

                            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.