cloudera.cloud.datahub_cluster_info module – Gather information about CDP Datahubs

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

Synopsis

  • Gather information about CDP Datahub 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"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

environment

aliases: env

string

The name of the Environment in which to find and describe the Datahubs.

name

aliases: datahub

string

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

If no name provided, all Datahubs will be listed and (optionally) constrained by the environment parameter.

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

# Gather detailed information about a named Datahub
- cloudera.cloud.datahub_cluster_info:
    name: example-datahub

# Gather detailed information about a Datahub in an Environment
- cloudera.cloud.datahub_cluster_info:
    environment: example-env-name

Return Values

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

Key

Description

datahubs

list / elements=dictionary

The information about the named Datahub or Datahubs

Returned: on success

clouderaManager

dictionary

The Cloudera Manager details.

Returned: success

platformVersion

string

CDP Platform version.

Returned: when supported

version

string

Cloudera Manager version.

Returned: always

cloudPlatform

string

The cloud platform.

Returned: when supported

clusterName

string

The name of the cluster.

Returned: always

clusterStatus

string

The status of the cluster.

Returned: when supported

clusterTemplateCrn

string

The CRN of the cluster template used for the cluster creation.

Returned: when supported

creationDate

string

The date when the cluster was created.

Return value is a date timestamp.

Returned: when supported

credentialCrn

string

The CRN of the credential.

Returned: when supported

crn

string

The CRN of the cluster.

Returned: always

datalakeCrn

string

The CRN of the attached datalake.

Returned: when supported

endpoints

list / elements=dictionary

The exposed service API endpoints.

Returned: when supported

endpoint

list / elements=dictionary

The endpoints.

Returned: always

displayName

string

The more consumable name of the exposed service.

Returned: always

knoxService

string

The related knox entry.

Returned: always

mode

string

The SSO mode of the given service.

Returned: always

open

boolean

Flag of the access status of the given endpoint.

Returned: always

serviceName

string

The name of the exposed service.

Returned: always

serviceUrl

string

The server url for the given exposed service’s API.

Returned: always

environmentCrn

string

The CRN of the environment.

Returned: when supported

environmentName

string

The name of the environment.

Returned: when supported

imageDetails

dictionary

The image details.

Returned: when supported

catalogName

string

The image catalog name.

Returned: when supported

catalogUrl

string

The image catalog URL.

Returned: when supported

id

string

The ID of the image used for cluster instances.

This is internally generated by the cloud provider to uniquely identify the image.

Returned: when supported

name

string

The name of the image used for cluster instances.

Returned: when supported

instanceGroups

list / elements=dictionary

The instance details.

Returned: when supported

availabilityZones

list / elements=string

List of availability zones associated with the instance group.

Returned: when supported

instances

list / elements=dictionary

List of instances in this instance group.

Returned: always

attachedVolumes

list / elements=dictionary

List of volumes attached to this instance.

Returned: when supported

count

integer

The number of volumes.

Returned: when supported

size

integer

The size of each volume in GB.

Returned: when supported

volumeType

string

The type of volumes.

Returned: when supported

availabilityZone

string

The availability zone of the instance.

Returned: when supported

clouderaManagerServer

boolean

Flag indicating if Cloudera Manager has been deployed or not.

Returned: when supported

fqdn

string

The fully-qualified domain name (FQDN) of the instance.

Returned: when supported

id

string

The ID of the given instance.

Returned: always

instanceGroup

string

The name of the instance group associated with the instance.

Returned: when supported

instanceType

string

The type of the given instance.

Values are GATEWAY, GATEWAY_PRIMARY, or CORE.

Returned: always

instanceVmType

string

The VM type of the instance.

Supported values depend on the cloud platform.

Returned: when supported

privateIp

string

The private IP of the given instance.

Returned: when supported

publicIp

string

The public IP of the given instance.

Returned: when supported

rackId

string

The rack ID of the instance in Cloudera Manager.

Returned: when supported

sshPort

integer

The SSH port for the instance.

Returned: when supported

state

string

The health state of the instance.

UNHEALTHY represents instances with unhealthy services, lost instances, or failed operations.

Returned: always

status

string

The status of the instance.

This includes information like whether the instance is being provisioned, stopped, decommissioning failures etc.

Returned: when supported

statusReason

string

The reason for the current status of this instance.

Returned: when supported

subnetId

string

The subnet ID of the instance.

Returned: when supported

name

string

The name of the instance group where the given instance is located.

Returned: always

subnetIds

list / elements=string

The list of subnet IDs in case of multi-availability zone setup.

Returned: when supported

nodeCount

integer

The cluster node count.

Returned: when supported

status

string

The status of the stack.

Returned: when supported

statusReason

string

The status reason.

Returned: when supported

workloadType

string

The workload type for the cluster.

Returned: when supported

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)