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

agent_header

aliases: user_agent

string

Set the HTTP user agent header when interacting with the CM API endpoint.

Default: "ClouderaFoundry"

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

force_tls

boolean

Flag to force TLS during CM API endpoint discovery.

If False, discovery will first try HTTP and follow any redirects.

Choices:

  • false ← (default)

  • true

host

aliases: hostname

string

Hostname of the CM API endpoint.

If set, the host parameter will trigger CM API endpoint discovery, which will follow redirects.

Mutually exclusive with url.

name

string

The name of the external mapping.

password

string / required

Password for access to the CM API endpoint.

This parameter is set to no_log.

port

integer

Port of the CM API endpoint.

If set, CM API endpoint discovery will connect to the designated port first and will follow redirects.

Default: 7180

proxy_server

aliases: proxy, http_proxy

string

Set the HTTP/S proxy server when interacting with the CM API endpoint.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

url

aliases: endpoint, cm_endpoint_url

string

The CM API endpoint URL and should include scheme, host, port, and API root path.

Mutually exclusive with host.

username

aliases: user

string / required

Username for access to the CM API endpoint.

uuid

string

The uuid of the external mapping.

verify_tls

boolean

Verify the TLS certificates for the CM API endpoint.

Choices:

  • false

  • true ← (default)

version

aliases: api_version

string

API version of the CM API endpoint.

Default: "True"

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

external_user_mappings_info

list / elements=dictionary

List of external user mappings within the cloudera manager.

Returned: always

auth_roles

list / elements=string

The list of auth roles associated with external user mapping.

Returned: always

name

string

The name of the external mapping.

Returned: always

type

string

The type of the external mapping.

Returned: always

uuid

string

The UUID of the external mapping.

Returned: always

Authors

  • Ronald Suplina (@rsuplina)