cloudera.cloud.opdb_info module – Gather information about CDP OpDB Databases

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

Synopsis

  • Gather information about CDP OpDB Databases

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 OpDB Databases.

Required with name to retrieve a Database

name

aliases: database

string

If a name is provided, that OpDB Database will be described.

environment must be provided if using name to retrieve a Database

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 OpDB Databases
- cloudera.cloud.opdb_info:

# Gather detailed information about a named Database
- cloudera.cloud.opdb_info:
    name: example-database
    env: example-environment

Return Values

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

Key

Description

databases

list / elements=complex

The information about the named Database or Databases

Returned: always

creationDate

string

The creation time of the database in UTC.

Returned: always

creatorCrn

string

The CRN of the database creator.

Returned: always

crn

string

The database’s crn.

Returned: always

databaseName

string

The name of the database.

Returned: always

dbVersion

string

The version of the Database.

Returned: always

environmentCrn

string

The crn of the database’s environment.

Returned: always

environmentName

boolean

The name of the Database’s environment

Returned: always

hueEndpoint

string

The Hue endpoint for the Database.

Returned: always

internalName

string

Internal cluster name for this database

Returned: always

k8sClusterName

string

The Kubernetes cluster name.

Returned: always

status

string

The status of the Database

Returned: always

storageLocation

string

HBase cloud storage location

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)