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

Note

This module is part of the cloudera.cloud collection (version 3.3.0).

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.

To use it in a playbook, specify: cloudera.cloud.dw_cluster_info.

New in cloudera.cloud 1.0.0

Synopsis

  • Gather information about CDP Data Warehouse Clusters.

  • Returns a single cluster when cluster_id is specified, all clusters in an environment when environment is specified, or all clusters when neither is specified.

  • The module supports check_mode.

Parameters

Parameter

Comments

access_key

string

If provided, the Cloudera on cloud API will use this value as its access key.

If not provided, the API will attempt to use the value from the environment variable CDP_ACCESS_KEY_ID.

Required if private_key is provided.

Mutually exclusive with credentials_path.

cluster_id

aliases: id

string

The identifier of the Data Warehouse Cluster.

Mutually exclusive with environment.

credentials_path

string

If provided, the Cloudera on cloud API will use this value as its credentials path.

If not provided, the API will attempt to use the value from the environment variable CDP_CREDENTIALS_PATH.

Default: "~/.cdp/credentials"

debug

aliases: debug_endpoints

boolean

If true, the module will capture the Cloudera on cloud HTTP log and return it in the sdk_out and sdk_out_lines fields.

Choices:

  • false ← (default)

  • true

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

If not provided, the API will attempt to use the value from the environment variable CDP_ENDPOINT_URL.

Mutually exclusive with endpoint_region.

endpoint_region

aliases: cdp_endpoint_region, cdp_region, region

string

Specify the Cloudera on cloud API endpoint region.

See Cloudera Control Plane regions for more information.

If not provided, the API will attempt to use the value from the environment variable CDP_REGION.

default is an alias for the us-west-1 region.

Mutually exclusive with endpoint.

Choices:

  • "default"

  • "us-west-1" ← (default)

  • "eu-1"

  • "ap-1"

endpoint_tls

aliases: verify_endpoint_tls, verify_tls, verify_api_tls

boolean

Verify the TLS certificates for the Cloudera on cloud API endpoint.

Choices:

  • false

  • true ← (default)

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.

http_agent

aliases: agent_header

string

The HTTP user agent to use for Cloudera on cloud API requests.

Default: "cloudera.cloud"

private_key

string

If provided, the Cloudera on cloud API will use this value as its private key.

If not provided, the API will attempt to use the value from the environment variable CDP_PRIVATE_KEY.

Required if access_key is provided.

profile

string

If provided, the Cloudera on cloud API will use this value as its profile.

If not provided, the API will attempt to use the value from the environment variable CDP_PROFILE.

Default: "default"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

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)

  • Jim Enright (@jenright)