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

Note

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

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.

Synopsis

  • Gather information about the Cloudera Manager host instance.

Requirements

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

  • cm_client

Parameters

Parameter

Comments

cluster_hostname

string

The name of the host.

host_id

string

The ID of the host.

Examples

---
- name: Get information about the host with hostname
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
    cluster_hostname: "Ecs_node_01"

- name: Get information about the host with host id
  cloudera.cluster.host_info:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
    cluster_hostname: "Ecs_node_01"

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

Return Values

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

Key

Description

cloudera_manager

list / elements=dictionary

Details about Cloudera Manager Host

Returned: success

clusterRef

string

A reference to the enclosing cluster.

Returned: optional

commissionState

string

Represents the Commission state of an entity.

Returned: optional

distribution

dictionary

OS distribution details.

Returned: optional

entity_status

string

The single value used by the Cloudera Manager UI to represent the status of the entity.

Returned: optional

health_checks

list / elements=string

Represents a result from a health test performed by Cloudera Manager for an entity.

Returned: optional

health_summary

string

The summary status of health check.

Returned: optional

host_id

string

A unique host identifier. This is not the same as the hostname (FQDN). It is a distinct value that remains the same even if the hostname changes.

Returned: optional

host_url

string

A URL into the Cloudera Manager web UI for this specific host.

Returned: optional

hostname

string

The hostname. This field is not mutable after the initial creation.

Returned: optional

ip_address

string

The host IP address. This field is not mutable after the initial creation.

Returned: optional

last_heartbeat

string

Time when the host agent sent the last heartbeat.

Returned: optional

maintenance_mode

boolean

Maintance mode of Cloudera Manager Service.

Returned: optional

maintenance_owners

list / elements=string

List of Maintance owners for Cloudera Manager Service.

Returned: optional

num_cores

integer

The number of logical CPU cores on this host.

Returned: optional

numPhysicalCores

integer

The number of physical CPU cores on this host.

Returned: optional

rack_id

string

The rack ID for this host.

Returned: optional

role_refs

list / elements=string

The list of roles assigned to this host.

Returned: optional

tags

list / elements=string

Tags associated with the host.

Returned: optional

total_phys_mem_bytes

string

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

Returned: optional

Authors

  • Ronald Suplina (@rsuplina)

Collection links