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 |
---|---|
Set the HTTP user agent header when interacting with the CM API endpoint. Default: |
|
The name of the associated (attached) cluster of the hosts. |
|
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. |
|
The unique identifier of the host. |
|
The hostname of the host. |
|
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.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 |
---|---|
Details about Cloudera Manager hosts. Returned: success |
|
The associated cluster for the host. Returned: when supported |
|
Commission state of the host. Returned: always |
|
Set of host configurations. Returned: when supported |
|
OS distribution details. Returned: when supported |
|
Lists all available health checks for the host. Returned: when supported |
|
The explanation of this health check. Returned: when supported |
|
Unique name of this health check. Returned: always |
|
The high-level health status of the health check. Returned: always Sample: |
|
Whether this health check is suppressed. A suppressed health check is not considered when computing the host’s overall health. Returned: when supported |
|
The high-level health status of the host. Returned: always Sample: |
|
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 |
|
The hostname of the host. Returned: when supported |
|
The IP address of the host. Returned: always |
|
Time when the host agent sent the last heartbeat. Returned: when supported |
|
Whether the host is in maintenance mode. Returned: when supported |
|
The list of objects that trigger this host to be in maintenance mode. Returned: when supported Sample: |
|
The number of logical CPU cores on this host. Returned: when supported |
|
The number of physical CPU cores on this host. Returned: when supported |
|
The rack ID for this host. Returned: when supported |
|
The list of role instances, i.e. role identifiers, assigned to this host. Returned: when supported |
|
The dictionary of tags for the host. Returned: when supported |
|
he amount of physical RAM on this host, in bytes. Returned: when supported |