cloudera.cloud.dw_data_visualization_info module – Gather information about CDP Data Visualization Instances

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

Synopsis

  • Gather information about CDP Data Visualization Instances

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"

cluster_id

string

The identifier of the Data Warehouse Cluster.

Mutually exclusive with environment.

data_visualization_id

aliases: id

string

The ID of Data Visualization Instance

Mutually exclusive with data_visualization_name.

data_visualization_name

aliases: name

string

The name of Data Visualization Instance

Mutually exclusive with data_visualization_id.

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

environment

aliases: env

string

The name or CRN of the Environment in which to find and describe Data Visualization Instances

Mutually exclusive with cluster_id.

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.

# Gather information about Data Visualization Instances within an CDW Environment
- cloudera.cloud.dw_data_visualization_info:
    env: example-environment

# Gather information about Data Visualization Instances within an CDW Environment
- cloudera.cloud.dw_data_visualization_info:
    cluster_id: env-xyzabc

# Gather information about specific Data Visualization Instance within an CDW Environment
- cloudera.cloud.dw_data_visualization_info:
    cluster_id: env-xyzabc
    data_visualization_name: example-name

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 Data Visualization Instance or Instances

Returned: always

creatorCrn

string

The CRN of the creator of the Data Visualization Instance

Returned: always

id

string

The unique id of the Data Visualization instance

Returned: always

imageVersion

string

The current version of Data Visualization

Returned: always

name

string

The name of the Data Visualization instance

Returned: always

size

string

The size of the Data Visualization instance

Returned: always

status

string

The status of the Data Visualization instance

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)

  • Ronald Suplina (@rsuplina)