cloudera.cloud.datalake_runtime_info module – Gather information about CDP Datalake Runtimes

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

Synopsis

  • Gather information about CDP Datalake Runtimes

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

default

boolean

Flag to return only the default Runtime.

Otherwise, all available Runtimes will be listed.

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.

# List basic information about available Datalake Runtimes
- cloudera.cloud.datalake_runtime_info:

# List basic information about the default Datalake Runtime
- cloudera.cloud.datalake_runtime_info:
    default: yes

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

versions

list / elements=dictionary

Details on available CDP Datalake Runtimes

Returned: on success

defaultRuntimeVersion

boolean

Flag designating default status.

Returned: always

runtimeVersion

string

The version number of the Runtime.

Returned: always

Sample: "7.2.6"

Authors

  • Webster Mudge (@wmudge)