cloudera.cluster.host module – Manage 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
.
New in cloudera.cluster 4.4.0
Synopsis
Allows for the management of Cloudera Manager hosts.
Functionality includes creation and deletion of hosts; host cluster assignment, host template, role config group assignment, and host and role instance configuration.
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. To remove from a cluster, omit and set purge=True. |
|
The host configuration overrides to set. To unset a parameter, use |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
Delay (interval), in seconds, between each attempt. Default: |
|
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 host template (and associated role instances) to apply to the host. |
|
The IP address of the host. |
|
Flag for whether the host should be in maintenance mode. Choices:
|
|
Message to log for any changes to the entity. Default: |
|
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. |
|
Flag for whether the declared role configuration overrides, tags, and associated role instance (via To clear all configuration and assignments, set empty dictionaries, e.g. Choices:
|
|
The rack ID for this host. |
|
Role config groups (and associated role instances) to apply to the host. |
|
The name of the role config group (and associated role instance) on the host. One of |
|
The service of the role config group (and associated role instance) on the host. |
|
The base role type of the role config group (and associated role instance) on the host. One of |
|
Role configuration overrides for the host. |
|
The host configuration overrides to set. To unset a parameter, use |
|
The service of the role instance on the host. |
|
The role type of the role instance on the host. |
|
Flag indicating if the declared role configurations overrides and tags should skipped REDACTED parameters during reconciliation. If set, the module will not attempt to update any existing parameter with a REDACTED value. Otherwise, the parameter value will be overridden. Choices:
|
|
Path to SSL CA certificate to use for validation. |
|
State of the host. The states Choices:
|
|
A set of tags applied to the host. To unset a tag, use |
|
Timeout, in seconds, before failing when joining a cluster. Default: |
|
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_info
Gather information about Cloudera Manager hosts.
Examples
- name: Create a host
cloudera.cluster.host:
host: "example.cloudera.host"
username: "will_jordan"
password: "S&peR4Ec*re"
rack_id: "/default"
cluster_hostname: "Ecs_node_01"
host_ip: "10.9.8.7"
state: "present"
- name: Attach a host to the Cluster
cloudera.cluster.host:
host: "example.cloudera.host"
username: "will_jordan"
name: "Base_Edge2AI_Node"
password: "S&peR4Ec*re"
cluster_hostname: "Ecs_node_01"
state: "attached"
- name: Detach a host to the Cluster
cloudera.cluster.host:
host: "example.cloudera.host"
username: "will_jordan"
name: "Base_Edge2AI_Node"
password: "S&peR4Ec*re"
cluster_hostname: "Ecs_node_01"
state: "detached"
- name: Remove a host
cloudera.cluster.host:
host: "example.cloudera.host"
username: "will_jordan"
password: "S&peR4Ec*re"
cluster_hostname: "Ecs_node_01"
state: "absent"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details about the host 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 |