cloudera.cluster.cm_autotls_info module – Retrieve Cloudera Manager configurations for Auto-TLS
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.cm_autotls_info
.
New in cloudera.cluster 5.0.0
Synopsis
Retrieve Cloudera Manager configurations for Auto-TLS
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 |
Notes
Note
This is a convenience module to retrieve Auto-TLS settings from the Cloudera Manager configuration.
Using the
cm_config_info
module will return similar settings.Requires
cm_client
.
See Also
See also
- cloudera.cluster.cm_config_info
Retrieve the Cloudera Manager configuration.
Examples
- name: Retrieve Auto-TLS settings
cloudera.cluster.cm_autotls_info:
host: example.cloudera.com
username: "jane_smith"
password: "S&peR4Ec*re"
register: __autotls_settings
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Cloudera Manager Server configurations with Auto-TLS settings where available. Returned: always |
|
The default value. Returned: when supported |
|
A textual description of the parameter. Returned: when supported |
|
A user-friendly name of the parameters, as would have been shown in the web UI. Returned: when supported |
|
The canonical name that identifies this configuration parameter. Returned: always |
|
If applicable, contains the related configuration variable used by the source project. Returned: when supported |
|
Whether this configuration is required for the object. If any required configuration is not set, operations on the object may not work. Returned: when supported |
|
Whether this configuration is sensitive, i.e. contains information such as passwords. This parameter might affect how the value of this configuration might be shared by the caller. Returned: when supported |
|
State of the configuration parameter after validation. For example, Returned: when supported |
|
A message explaining the parameter’s validation state. Returned: when supported |
|
Whether validation warnings associated with this parameter are suppressed. In general, suppressed validation warnings are hidden in the Cloudera Manager UI. Configurations that do not produce warnings will not contain this field. Returned: when supported |
|
The user-defined value. When absent, the default value (if any) will be used. Can also be absent, when enumerating allowed configs. Returned: when supported |