cloudera.cloud.dw_cluster_info module – Gather information about CDP Data Warehouse Clusters

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

Synopsis

  • Gather information about CDP Data Warehouse Clusters

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"

cluster_id

aliases: id

string

The identifier of the Data Warehouse Cluster.

Mutually exclusive with environment.

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

environment

aliases: env

string

The name or CRN of the Environment in which to find and describe Data Warehouse Clusters.

Mutually exclusive with cluster_id.

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 information about all Data Warehouse Clusters
- cloudera.cloud.dw_cluster_info:

# Gather information about all Data Warehouse Clusters within an Environment
- cloudera.cloud.dw_cluster_info:
    env: example-environment

# Gather information about an identified Cluster
- cloudera.cloud.dw_cluster_info:
    cluster_id: env-xyzabc

Return Values

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

Key

Description

clusters

list / elements=dictionary

The information about the named Cluster or Clusters

Returned: always

cloudPlatform

string

The cloud platform of the environment that was used to create this cluster.

Returned: always

creationDate

string

The creation timestamp of the cluster in UTC.

Returned: always

creator

dictionary

The cluster creator details.

Returned: always

crn

string

The Actor CRN.

Returned: always

email

string

Email address (users).

Returned: when supported

machineUsername

string

Username (machine users).

Returned: when supported

workloadUsername

string

Username (users).

Returned: when supported

crn

string

The cluster’s CRN.

Returned: always

environmentCrn

string

The CRN of the cluster’s Environment

Returned: always

id

string

The cluster identifier.

Returned: always

status

string

The status of the cluster

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)