community.general.rax_identity – Load Rackspace Cloud Identity
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_identity.
Synopsis
- Verifies Rackspace Cloud credentials and returns identity information
 
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
 - pyrax
 
Parameters
| 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/
   |  |
|   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    string    |   Default: "rackspace"   |    Authentication mechanism to use, such as rackspace or keystone.   |  
|   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.   |  |
|   username    string    |    Rackspace username, overrides credentials.   |  |
|   validate_certs    boolean    |   
  |    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_CREDENTIALSandRAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating - 
RAX_USERNAMEandRAX_API_KEYobviate the use of a credentials file - 
RAX_REGIONdefines a Rackspace Public Cloud region (DFW, ORD, LON, …) 
Examples
- name: Load Rackspace Cloud Identity
  gather_facts: False
  hosts: local
  connection: local
  tasks:
    - name: Load Identity
      local_action:
        module: rax_identity
        credentials: ~/.raxpub
        region: DFW
      register: rackspace_identity
  Authors
- Christopher H. Laco (@claco)
 - Matt Martz (@sivel)
 
    © 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_identity_module.html