summaryrefslogtreecommitdiffstats
path: root/ansible_collections/openstack/cloud/plugins/modules/auth.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/openstack/cloud/plugins/modules/auth.py')
-rw-r--r--ansible_collections/openstack/cloud/plugins/modules/auth.py34
1 files changed, 9 insertions, 25 deletions
diff --git a/ansible_collections/openstack/cloud/plugins/modules/auth.py b/ansible_collections/openstack/cloud/plugins/modules/auth.py
index 1f2c516e4..e991209d0 100644
--- a/ansible_collections/openstack/cloud/plugins/modules/auth.py
+++ b/ansible_collections/openstack/cloud/plugins/modules/auth.py
@@ -1,56 +1,40 @@
#!/usr/bin/python
+# -*- coding: utf-8 -*-
# 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 = '''
+DOCUMENTATION = r'''
---
module: auth
-short_description: Retrieve an auth token
+short_description: Retrieve auth token from OpenStack cloud
author: OpenStack Ansible SIG
description:
- - Retrieve an auth token from an OpenStack Cloud
-requirements:
- - "python >= 3.6"
- - "openstacksdk"
+ - Retrieve auth token from OpenStack cloud
extends_documentation_fragment:
- openstack.cloud.openstack
'''
-EXAMPLES = '''
-- name: Authenticate to the cloud and retrieve the service catalog
+EXAMPLES = r'''
+- name: Authenticate to cloud and return auth token
openstack.cloud.auth:
cloud: rax-dfw
-
-- name: Show service catalog
- debug:
- var: service_catalog
'''
-RETURN = '''
+RETURN = r'''
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))
+ self.exit_json(changed=False,
+ auth_token=self.conn.auth_token)
def main():