cloudera.cluster.control_plane_info module – Retrieve information about control planes

Note

This module is part of the cloudera.cluster collection (version 5.0.0).

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.cluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cluster.control_plane_info.

Synopsis

  • Gather information about control planes in Cloudera on-premise deployments.

  • Returns details about available control planes including their configuration, versions, and metadata.

Requirements

The below requirements are needed on the host that executes this module.

  • cm-client

Parameters

Parameter

Comments

agent_header

aliases: user_agent

string

Set the HTTP user agent header when interacting with the CM API endpoint.

Default: "ClouderaFoundry"

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

force_tls

boolean

Flag to force TLS during CM API endpoint discovery.

If False, discovery will first try HTTP and follow any redirects.

Choices:

  • false ← (default)

  • true

host

aliases: hostname

string

Hostname of the CM API endpoint.

If set, the host parameter will trigger CM API endpoint discovery, which will follow redirects.

Mutually exclusive with url.

password

string / required

Password for access to the CM API endpoint.

This parameter is set to no_log.

port

integer

Port of the CM API endpoint.

If set, CM API endpoint discovery will connect to the designated port first and will follow redirects.

Default: 7180

proxy_server

aliases: proxy, http_proxy

string

Set the HTTP/S proxy server when interacting with the CM API endpoint.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

url

aliases: endpoint, cm_endpoint_url

string

The CM API endpoint URL and should include scheme, host, port, and API root path.

Mutually exclusive with host.

username

aliases: user

string / required

Username for access to the CM API endpoint.

verify_tls

boolean

Verify the TLS certificates for the CM API endpoint.

Choices:

  • false

  • true ← (default)

version

aliases: api_version

string

API version of the CM API endpoint.

Default: "True"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

See Also

See also

cloudera.cluster.cluster

Manage the lifecycle and state of a cluster.

Examples

- name: Gather information about all control planes
  cloudera.cluster.control_plane_info:
    host: "example.cloudera.host"
    username: "admin"
    password: "admin_password"
  register: control_planes_output

Return Values

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

Key

Description

control_planes

list / elements=dictionary

List of control planes in the Cloudera Manager deployment.

Returned: always

dns_suffix

string

The domain where the control plane is installed.

Returned: optional

kubernetes_type

string

The Kubernetes type on which the control plane is running.

Returned: optional

manifest

string

The content of the manifest JSON of the control plane.

Returned: optional

namespace

string

The namespace where the control plane is installed.

Returned: optional

remote_repo_url

string

The URL of the remote repository where the artifacts used to install the control plane are hosted.

Returned: optional

tags

list / elements=dictionary

Tags associated with the control plane.

Returned: optional

name

string

The name of the tag.

Returned: always

value

string

The value of the tag.

Returned: always

uuid

string

The universally unique ID of this control plane in Cloudera Manager.

Returned: optional

values_yaml

string

The content of the values YAML used to configure the control plane.

Returned: optional

version

string

The CDP version of the control plane.

Returned: optional

Authors

  • Jim Enright (@jimright)