cloudera.cloud.datahub_definition_info module – Gather information about CDP Datahub Cluster Definitions

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

Synopsis

  • Gather information about CDP Datahub Cluster Definitions

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"

content

aliases: definition_content

boolean

Flag dictating if the workload template content of the cluster definition is returned

Choices:

  • false ← (default)

  • true

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

name

aliases: definition, crn

string

If a name is provided, that Definition will be described.

If a crn is provided, that Definition will be described.

If no name provided, all Definitions will be listed.

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 all Datahubs
- cloudera.cloud.datahub_definition_info:

# Gather detailed information about a named Datahub
- cloudera.cloud.datahub_definition_info:
    name: example-definition

Return Values

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

Key

Description

definitions

list / elements=complex

The information about the named Definition or Definitions

Returned: on success

cloudPlatform

string

The cloud provider of the cluster definition.

Returned: always

clusterDefinitionName

string

The name of the cluster definition.

Returned: always

crn

string

The CRN of the cluster definition.

Returned: always

description

string

The description of the cluster definition.

Returned: always

nodeCount

string

The node count of the cluster definition.

Returned: always

productVersion

string

The product version of the cluster definition.

Returned: always

type

string

The type of cluster definition.

Returned: always

Sample: "['DATAENGINEERING', 'DATAMART', 'DISCOVERY_DATA_AND_EXPLORATION', 'FLOW_MANAGEMENT', 'OPERATIONALDATABASE', 'STREAMING']"

workloadTemplate

string

The workload template of the cluster definition, in JSON.

Returned: when specified

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

  • Chris Perro (@cmperro)

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)