cloudera.cloud.env_auth module – Set authentication details for the current CDP user

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.env_auth.

Synopsis

  • Set authentication details for the current CDP user for one or more Environments.

  • 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_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

name

aliases: environment

list / elements=string

The targeted environment(s).

If no environment is specified, all environments are affected.

password

aliases: workload_password

string / required

The workload password to set for the current CDP user.

Passwords must be a minimum of 8 characters and no more than 64 characters and should be a combination of upper case, lower case, digits, and special characters.

Set to ‘no_log’ within Ansible.

profile

string

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

strict

boolean

A flag to ignore Conflict errors on password updates.

Choices:

  • false

  • true ← (default)

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.

# Set the workload user password for the current CDP user on all environments
- cloudera.cloud.env_auth:
    password: Cloudera@2020!

# Set the workload user password for the current CDP user on selected environments
- cloudera.cloud.env_auth:
    name:
      - one-environment
      - two-environment
    password: Cloudera@2020!

Return Values

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

Key

Description

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)