cloudera.cloud.datahub_template_info module – Gather information about CDP Datahub Cluster Templates

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

Synopsis

  • Gather information about CDP Datahub Cluster Templates

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

name

aliases: template

string

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

If no name provided, all Templates will be listed.

profile

string

If provided, the CDP SDK will use this value as its profile.

return_content

aliases: template_content, content

boolean

Flag dictating if cluster template content is returned

Choices:

  • false ← (default)

  • true

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_template_info:

# Gather detailed information about a named Datahub
- cloudera.cloud.datahub_template_info:
    name: example-template

# Gather detailed information about a named Datahub, including the template contents in JSON
- cloudera.cloud.datahub_template_info:
    name: example-template
    return_content: 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

templates

list / elements=complex

The information about the named Template or Templates

Returned: on success

clusterTemplateContent

string

The cluster template contents, in JSON.

Returned: when specified

clusterTemplateName

string

The name of the cluster template.

Returned: always

crn

string

The CRN of the cluster template.

Returned: always

description

string

The description of the cluster template.

Returned: always

instanceGroupCount

string

The instance group count of the cluster.

Returned: always

productVersion

string

The product version.

Returned: always

status

string

The status of the cluster template.

Returned: always

Sample: "['DEFAULT', 'USER_MANAGED']"

tags

dictionary

Tags added to the cluster template

Returned: always

key

string

The key of the tag.

Returned: always

value

string

The value of the tag.

Returned: always

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)