cloudera.cloud.account_auth_info module – Gather information about CDP Account authentication settings

Note

This module is part of the cloudera.cloud collection (version 2.5.1).

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.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cloud.account_auth_info.

Synopsis

  • Gather information about the authentication settings for a CDP Account.

  • The module supports check_mode.

Requirements

The below requirements are needed on the host that executes this module.

  • cdpy

Parameters

Parameter

Comments

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

debug

aliases: debug_cdpsdk

boolean

Flag to capture and return the debugging log of the underlying CDP SDK.

If set, the log level will be set from ERROR to DEBUG.

Choices:

  • false ← (default)

  • true

profile

string

If provided, the CDP SDK will use this value as its profile.

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Note: These examples do not set authentication details.

# Gather information about the Account authentication settings
- cloudera.cloud.account_auth_info:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

account

dictionary

Returns the authentication settings for the CDP Account

Returned: always

clouderaSSOLoginEnabled

boolean

Flag indicating whether interactive login using Cloudera SSO is enabled.

Returned: always

workloadPasswordPolicy

dictionary

Information about the workload password policy for an account.

Returned: always

maxPasswordLifetimeDays

integer

The max lifetime, in days, of the password. If ‘0’, passwords never expire.

Returned: always

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)