cloudera.cloud.de_info module – Gather information about CDP DE Workspaces

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

Synopsis

  • Gather information about CDP DE Workspaces

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 DE service(s).

name

aliases: name

string

If a name is provided, that DE service will be described (if it exists)

Note that there should be only 1 or 0 (non-deleted) services with a given name

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 DE Services
- cloudera.cloud.de_info:

# List basic information about all DE Services within a given environment
- cloudera.cloud.de_info:
    environment: example-environment

# Gather detailed information about a named DE Service
- cloudera.cloud.de_info:
    name: example-service

# Gather detailed information about a named DE Service within a particular environment
- cloudera.cloud.de_info:
    name: example-service
    environment: example-environment

Return Values

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

Key

Description

services

list / elements=complex

List of DE service descriptions

Returned: always

chartValueOverrides

list / elements=complex

Status of the CDE Service.

Returned: if full service description

ChartValueOverridesResponse

list / elements=string

Returned: always

chartName

string

Name of the chart that has to be overridden.

Returned: always

overrides

string

Space separated key value-pairs for overriding chart values (colon separated)

Returned: always

cloudPlatform

string

The cloud platform where the CDE service is enabled.

Returned: if full service description

clusterFqdn

string

FQDN of the CDE service.

Returned: if full service description

clusterId

string

Cluster Id of the CDE Service.

Returned: always

creatorCrn

string

CRN of the creator.

Returned: if full service description

creatorEmail

string

Email Address of the CDE creator.

Returned: always

dataLakeAtlasUIEndpoint

string

Endpoint of Data Lake Atlas.E

Returned: if full service description

dataLakeFileSystems

string

The Data lake file system.

Returned: if full service description

enablingTime

string

Timestamp of service enabling.

Returned: always

environmentCrn

string

CRN of the environment.

Returned: if full service description

environmentName

string

CDP Environment Name.

Returned: always

logLocation

string

Location for the log files of jobs.

Returned: if full service description

name

string

Name of the CDE Service.

Returned: always

resources

complex

Resources details of CDE Service.

Returned: if full service description

ServiceResources

complex

Object to store resources for a CDE service.

Returned: always

initial_instances

string

Initial instances for the CDE service.

Returned: always

initial_spot_instances

string

Initial Spot Instances for the CDE Service.

Returned: always

instance_type

string

Instance type of the CDE service.

Returned: always

max_instances

string

Maximum instances for the CDE service.

Returned: always

max_spot_instances

string

Maximum Number of Spot instances.

Returned: always

min_instances

string

Minimum Instances for the CDE service.

Returned: always

min_spot_instances

string

Minimum number of spot instances for the CDE service.

Returned: always

root_vol_size

string

Root Volume Size.

Returned: always

status

string

Status of the CDE Service.

Returned: always

tenantId

string

CDP tenant ID.

Returned: if full service description

Authors

  • Curtis Howard (@curtishoward)

  • Alan Silva (@acsjumpi)