cloudera.cloud.env_cred_info module – Gather information about CDP Credentials

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

Synopsis

  • Gather information about CDP Credentials using the CDP SDK.

  • 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

string

If a name is provided, the module will describe the found Credential. If the Credential is not found, the module will return an empty dictionary.

If no name is provided, the module will list all found Credentials. If no Credentials are found, the module will return an empty list.

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 all Credentials
- cloudera.cloud.env_cred_info:

# Gather information about a named Credential
- cloudera.cloud.env_cred_info:
    name: example-credential

Return Values

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

Key

Description

credentials

complex

Returns an array of objects for the named Credential or all Credentials.

Returned: always

cloudPlatform

string

The name of the cloud provider for the Credential.

Returned: always

Sample: "AWS"

credentialName

string

The name of the Credential.

Returned: always

Sample: "example-credential"

crn

string

The CDP CRN value derived from the cross-account Role ARN used during creation.

Returned: always

Sample: "crn:cdp:environments:us-west-1:558bc1d2-8867-4357-8524-311d51259233:credential:61eb5b97-226a-4be7-b56d-795d18a043b5"

description

string

The description of the Credential.

Returned: when supported

Sample: "An example Credential"

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)