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 |
---|---|
Set the HTTP user agent header when interacting with the CM API endpoint. Default: |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
Flag to force TLS during CM API endpoint discovery. If Choices:
|
|
Hostname of the CM API endpoint. If set, the Mutually exclusive with url. |
|
Password for access to the CM API endpoint. This parameter is set to |
|
Port of the CM API endpoint. If set, CM API endpoint discovery will connect to the designated port first and will follow redirects. Default: |
|
Set the HTTP/S proxy server when interacting with the CM API endpoint. |
|
Path to SSL CA certificate to use for validation. |
|
The CM API endpoint URL and should include scheme, host, port, and API root path. Mutually exclusive with host. |
|
Username for access to the CM API endpoint. |
|
Verify the TLS certificates for the CM API endpoint. Choices:
|
|
API version of the CM API endpoint. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
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 |
---|---|
List of control planes in the Cloudera Manager deployment. Returned: always |
|
The domain where the control plane is installed. Returned: optional |
|
The Kubernetes type on which the control plane is running. Returned: optional |
|
The content of the manifest JSON of the control plane. Returned: optional |
|
The namespace where the control plane is installed. Returned: optional |
|
The URL of the remote repository where the artifacts used to install the control plane are hosted. Returned: optional |
|
Tags associated with the control plane. Returned: optional |
|
The name of the tag. Returned: always |
|
The value of the tag. Returned: always |
|
The universally unique ID of this control plane in Cloudera Manager. Returned: optional |
|
The content of the values YAML used to configure the control plane. Returned: optional |
|
The CDP version of the control plane. Returned: optional |