cloudera.cluster.external_user_mappings_info module – Retrieve details of external user mappings
Note
This module is part of the cloudera.cluster collection (version 5.0.0).
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cloudera.cluster
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cloudera.cluster.external_user_mappings_info
.
New in cloudera.cluster 5.0.0
Synopsis
Retrieve details of a specific or all external user mappings within the Cloudera Manager.
Requirements
The below requirements are needed on the host that executes this module.
cm_client
Parameters
Parameter |
Comments |
---|---|
Set the HTTP user agent header when interacting with the CM API endpoint. Default: |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
Flag to force TLS during CM API endpoint discovery. If Choices:
|
|
Hostname of the CM API endpoint. If set, the Mutually exclusive with url. |
|
The name of the external mapping. |
|
Password for access to the CM API endpoint. This parameter is set to |
|
Port of the CM API endpoint. If set, CM API endpoint discovery will connect to the designated port first and will follow redirects. Default: |
|
Set the HTTP/S proxy server when interacting with the CM API endpoint. |
|
Path to SSL CA certificate to use for validation. |
|
The CM API endpoint URL and should include scheme, host, port, and API root path. Mutually exclusive with host. |
|
Username for access to the CM API endpoint. |
|
The uuid of the external mapping. |
|
Verify the TLS certificates for the CM API endpoint. Choices:
|
|
API version of the CM API endpoint. Default: |
Examples
- name: Retrieve the defailts about a specific user mapping
cloudera.cluster.external_user_mappings_info:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
name: "test_mapping"
- name: Retrieve the defailts about a specific user mapping with uuid parameter
cloudera.cluster.external_user_mappings_info:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
uuid: "1111aa-1111-111a-111a-11111111"
- name: Retrieve the details about all user mappings
cloudera.cluster.external_user_mappings_info:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of external user mappings within the cloudera manager. Returned: always |
|
The list of auth roles associated with external user mapping. Returned: always |
|
The name of the external mapping. Returned: always |
|
The type of the external mapping. Returned: always |
|
The UUID of the external mapping. Returned: always |