cloudera.cloud.env_proxy_info module – Gather information about CDP Environment Proxies

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

Synopsis

  • Gather information about CDP Environment Proxy Configurations

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

name

string

If a name is provided, that proxy configuration will be described

If no name is provided, all proxy configurations will be listed

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 Proxy Configurations
- cloudera.cloud.env_proxy_info:

# Gather detailed information about a named Proxy Configuration
- cloudera.cloud.env_proxy_info:
    name: example-proxy

Return Values

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

Key

Description

proxies

list / elements=dictionary

Details on the proxies.

Returned: on success

crn

string

The CRN of the proxy config.

Returned: always

Sample: "crn:cdp:environments:us-west-1:558bc1d2-8867-4357-8524-311d51259233:credential:eb6c5fc8-38fe-4c3c-8194-1a0f05edc010"

description

string

A description for the proxy config.

Returned: when supported

Sample: "Example proxy configuration"

host

string

The proxy host.

Returned: always

Sample: "example.cloudera.com"

port

integer

The proxy port.

Returned: always

Sample: 8443

protocol

string

The proxy protocol.

Returned: always

Sample: "https"

proxyConfigName

string

The name of the proxy config.

Returned: always

Sample: "example-proxy-config"

user

string

The proxy user.

Returned: when supported

Sample: "proxy_username"

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)