cloudera.cloud.env_telemetry module – Set CDP environment telemetry

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

Synopsis

  • Set a CDP environment deployment log collection and workload analytics.

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

logs_collection

aliases: report_deployment_logs

boolean

A flag to specify the availability of the environment’s deployment log collection.

Choices:

  • false

  • true

name

aliases: environment

string / required

The targeted environment.

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)

workload_analytics

aliases: analytics

boolean

A flag to specify the availability of the environment’s workload analytics.

Choices:

  • false

  • true

Examples

# Note: These examples do not set authentication details.

# Turn off both workload analytics and log collection
- cloudera.cloud.env_telemetry:
    name: the-environment
    workload_analytics: no
    logs_collection: no

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)