cloudera.cluster.host_info module – Gather information about Cloudera Manager hosts

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

New in cloudera.cluster 4.4.0

Synopsis

  • Gather information about the Cloudera Manager host instances.

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"

cluster

aliases: cluster_name

string

The name of the associated (attached) cluster of the hosts.

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.

host_id

string

The unique identifier of the host.

name

aliases: cluster_hostname

string

The hostname of the host.

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

Manage Cloudera Manager hosts.

Examples

- name: Get information about the host via hostname
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
    name: "ecs_node_01.cldr.internal"

- name: Get information about the host via host id
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
    host_id: "1a12c6a0-9277-4824-aaa9-38e24a6f5efe"

- name: Get information about all the hosts registered with Cloudera Manager
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"

- name: Get information about all the hosts attached to a cluster
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
    cluster: "ExampleCluster"

Return Values

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

Key

Description

hosts

list / elements=dictionary

Details about Cloudera Manager hosts.

Returned: success

cluster_name

string

The associated cluster for the host.

Returned: when supported

commission_state

string

Commission state of the host.

Returned: always

config

dictionary

Set of host configurations.

Returned: when supported

distribution

dictionary

OS distribution details.

Returned: when supported

health_checks

list / elements=dictionary

Lists all available health checks for the host.

Returned: when supported

explanation

string

The explanation of this health check.

Returned: when supported

name

string

Unique name of this health check.

Returned: always

summary

string

The high-level health status of the health check.

Returned: always

Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"

suppressed

boolean

Whether this health check is suppressed.

A suppressed health check is not considered when computing the host’s overall health.

Returned: when supported

health_summary

string

The high-level health status of the host.

Returned: always

Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"

host_id

string

The unique ID of the host.

This is not the same as the hostname (FQDN); host_id is a distinct value that remains static across hostname changes.

Returned: always

hostname

string

The hostname of the host.

Returned: when supported

ip_address

string

The IP address of the host.

Returned: always

last_heartbeat

string

Time when the host agent sent the last heartbeat.

Returned: when supported

maintenance_mode

boolean

Whether the host is in maintenance mode.

Returned: when supported

maintenance_owners

list / elements=string

The list of objects that trigger this host to be in maintenance mode.

Returned: when supported

Sample: ["CLUSTER", "SERVICE", "ROLE", "HOST", "CONTROL_PLANE"]

num_cores

integer

The number of logical CPU cores on this host.

Returned: when supported

numPhysicalCores

integer

The number of physical CPU cores on this host.

Returned: when supported

rack_id

string

The rack ID for this host.

Returned: when supported

roles

list / elements=string

The list of role instances, i.e. role identifiers, assigned to this host.

Returned: when supported

tags

dictionary

The dictionary of tags for the host.

Returned: when supported

total_phys_mem_bytes

string

he amount of physical RAM on this host, in bytes.

Returned: when supported

Authors

  • Ronald Suplina (@rsuplina)

  • Webster Mudge (@wmudge)