cloudera.cluster.host_config_info module – Retrieves the configuration details of a specific host.

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

New in cloudera.cluster 4.4.0

DEPRECATED

Removed in:

version 6.0.0

Why:

Consolidation of configuration management.

Alternative:

Use cloudera.cluster.host_info

Synopsis

  • Gather configuration information about a specific host.

Requirements

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

  • cm_client

Parameters

Parameter

Comments

name

aliases: host_id, host_name

string / required

The ID or name of the host.

view

string

The view to materialize.

Choices:

  • "full" ← (default)

  • "summary"

Examples

- name: Gather the configuration details for a host
  cloudera.cluster.host_config_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    name: example.cloudera.com
    view: summary

- name: Gather the configuration details in 'full' for a host
  cloudera.cluster.host_config_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    name: example.cloudera.com
    view: full

Return Values

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

Key

Description

config

list / elements=dictionary

Configuration details about a specific host.

Returned: always

default

string

The default value.

Requires full view.

Returned: when supported

description

string

A textual description of the parameter.

Requires full view.

Returned: when supported

display_name

string

A user-friendly name of the parameters, as would have been shown in the web UI.

Requires full view.

Returned: when supported

name

string

The canonical name that identifies this configuration parameter.

Returned: always

string

If applicable, contains the related configuration variable used by the source project.

Requires full view.

Returned: when supported

required

boolean

Whether this configuration is required for the object.

If any required configuration is not set, operations on the object may not work.

Requires full view.

Returned: when supported

sensitive

boolean

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

validate_state

string

State of the configuration parameter after validation.

For example, OK, WARNING, and ERROR.

Requires full view.

Returned: when supported

validation_message

string

A message explaining the parameter’s validation state.

Requires full view.

Returned: when supported

validation_warnings_suppressed

boolean

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.

Requires full view.

Returned: when supported

value

string

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

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ronald Suplina (@rsuplina)