summaryrefslogtreecommitdiffstats
path: root/ansible_collections/openstack/cloud/plugins/modules/auth.py
blob: 1f2c516e4ed9d5c2fdd34bc5567a4ee27c7b9d05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#!/usr/bin/python

# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = '''
---
module: auth
short_description: Retrieve an auth token
author: OpenStack Ansible SIG
description:
    - Retrieve an auth token from an OpenStack Cloud
requirements:
    - "python >= 3.6"
    - "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

EXAMPLES = '''
- name: Authenticate to the cloud and retrieve the service catalog
  openstack.cloud.auth:
    cloud: rax-dfw

- name: Show service catalog
  debug:
    var: service_catalog
'''

RETURN = '''
auth_token:
    description: Openstack API Auth Token
    returned: success
    type: str
service_catalog:
    description: A dictionary of available API endpoints
    returned: success
    type: dict
'''

from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule


class AuthModule(OpenStackModule):
    argument_spec = dict()
    module_kwargs = dict()

    def run(self):
        self.exit_json(
            changed=False,
            ansible_facts=dict(
                auth_token=self.conn.auth_token,
                service_catalog=self.conn.service_catalog))


def main():
    module = AuthModule()
    module()


if __name__ == '__main__':
    main()