os_auth – Retrieve an auth token¶
Requirements¶
The below requirements are needed on the host that executes this module.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Parameters¶
Notes¶
Note
- The standard OpenStack environment variables, such as OS_USERNAMEmay be used instead of providing explicit values.
- Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples¶
- name: Authenticate to the cloud and retrieve the service catalog
  os_auth:
    cloud: rax-dfw
- name: Show service catalog
  debug:
    var: service_catalog
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| auth_token 
                  string
                                       | success | Openstack API Auth Token | 
| service_catalog 
                  dictionary
                                       | success | A dictionary of available API endpoints | 
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Monty Taylor (@emonty)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
