cloudera.cloud.df_service_info module – Gather information about CDP DataFlow Services

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

Synopsis

  • Gather information about CDP DataFlow Services

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

df_crn

string

If a df_crn is provided, that DataFlow Service will be described

Mutually exclusive with name and env_crn

env_crn

string

If an env_crn is provided, the DataFlow Service for that Environment will be described

Mutually exclusive with name and df_crn

name

string

If a name is provided, that DataFlow Service will be described

Must be the string name of the CDP Environment

Mutually exclusive with df_crn and env_crn

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)

Notes

Note

  • This feature this module is for is in Technical Preview

Examples

# Note: These examples do not set authentication details.

# List basic information about all DataFlow Services
- cloudera.cloud.df_info:

# Gather detailed information about a named DataFlow Service using a name
- cloudera.cloud.df_info:
    name: example-service

# Gather detailed information about a named DataFlow Service using a Dataflow CRN
- cloudera.cloud.df_info:
    df_crn: crn:cdp:df:region:tenant-uuid4:service:service-uuid4

# Gather detailed information about a named DataFlow Service using an Environment CRN
- cloudera.cloud.df_info:
    df_crn: crn:cdp:environments:region:tenant-uuid4:environment:environment-uuid4

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

services

list / elements=complex

The information about the named DataFlow Service or DataFlow Services

Returned: always

activeErrorAlertCount

integer

Current count of active alerts classified as an error.

Returned: always

activeWarningAlertCount

integer

Current count of active alerts classified as a warning.

Returned: always

authorizedIpRanges

list / elements=string

The authorized IP Ranges.

Returned: always

cloudPlatform

string

The cloud platform of the environment.

Returned: always

clusterId

string

Cluster id of the environment.

Returned: if enabled

crn

string

The DataFlow Service’s CRN.

Returned: always

deploymentCount

string

The deployment count.

Returned: always

dfLocalUrl

string

The URL of the environment local DataFlow application.

Returned: always

environmentCrn

string

The DataFlow Service’s Parent Environment CRN.

Returned: always

instanceType

string

The instance type of the kubernetes nodes currently in use by DataFlow for this environment.

Returned: always

k8sNodeCount

integer

The number of kubernetes nodes currently in use by DataFlow for this environment.

Returned: always

maxK8sNodeCount

string

The maximum number of kubernetes nodes that environment may scale up under high-demand situations.

Returned: always

minK8sNodeCount

integer

The minimum number of Kubernetes nodes that need to be provisioned in the environment.

Returned: always

name

string

The DataFlow Service’s parent environment name.

Returned: always

region

string

The region of the environment.

Returned: always

status

dictionary

The status of a DataFlow enabled environment.

Returned: always

message

string

A status message for the environment.

Returned: always

state

string

The state of the environment.

Returned: always

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)