cloudera.cluster.cluster_info module – Retrieve details about one or more clusters

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

Synopsis

  • Retrieves details about one or more clusters managed by Cloudera Manager

Requirements

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

  • cm_client

Parameters

Parameter

Comments

name

string

Name of Cloudera Manager cluster.

This parameter specifies the name of the cluster from which data will be gathered.

Examples

- name: Get information about the cluster
  cloudera.cluster.cluster_info:
    host: example.cloudera.com
    username: "jane_smith"
    name: "OneNodeCluster"
    password: "S&peR4Ec*re"
    port: "7180"

- name: Get information about all clusters
  cloudera.cluster.cluster_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    port: "7180"

Return Values

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

Key

Description

clusters

list / elements=dictionary

Details about a Cloudera Manager cluster or clusters

Returned: success

cluster_type

string

The type of cluster.

Returned: always

display_name

string

The name of the cluster displayed in the Cloudera Manager UI.

Returned: always

entity_status

string

Health status of the cluster.

Returned: always

maintenance_mode

boolean

Maintance mode of cluster.

Returned: always

maintenance_owners

list / elements=string

List of maintance owners for cluster.

Returned: always

name

string

The name of the cluster.

Returned: always

tags

list / elements=string

List of tags for cluster.

Returned: always

uuid

boolean

The unique ID of the cluster.

Returned: always

version

string

Version of the cluster installed.

Returned: always

Authors

  • Ronald Suplina (@rsuplina)

Collection links