cloudera.cluster.cm_service_info module – Retrieve information about the Cloudera Management Services

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

Synopsis

  • Gather information about the Cloudera Manager service.

Requirements

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

  • cm_client

Examples

---
- name: Gather details using an host
  cloudera.cluster.cm_version:
    host: "example.cloudera.host"
    username: "will_jordan"
    password: "S&peR4Ec*re"
  register: cm_output

Return Values

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

Key

Description

cloudera_manager

dictionary

Details about Cloudera Manager Service

Returned: success

client_config_staleness_status

string

Status of Client configuration for Cloudera Manager Service.

Returned: optional

cluster_ref

string

Reference to a cluster.

Returned: optional

config

dictionary

Configuration details for Cloudera Manager Service.

Returned: optional

config_stale

string

Configuration state of Cloudera Manager Service.

Returned: optional

config_staleness_status

string

Status of configuration staleness for Cloudera Manager Service.

Returned: optional

display_name

dictionary

Display name of Cloudera Manager Service.

Returned: optional

entity_status

string

Health status of entities for Cloudera Manager Service.

Returned: optional

health_checks

dictionary

Lists all available health checks for Cloudera Manager Service.

Returned: optional

health_summary

string

Health of the Cloudera Manager Service.

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

name

string

The Cloudera Manager service name.

Returned: optional

replication_schedules

list / elements=string

List of replication schedules for Cloudera Manager Service.

Returned: optional

role_config_groups

list / elements=string

List of role configuration groups for Cloudera Manager Service.

Returned: optional

role_instances_url

string

Role instance url for Cloudera Manager Service.

Returned: optional

roles

dictionary

Role list of Cloudera Manager Service.

Returned: optional

service_state

string

State of the Cloudera Manager Service.

Returned: optional

service_url

string

Service url for Cloudera Manager Service.

Returned: optional

service_version

string

Version of Cloudera Manager Service.

Returned: optional

snapshot_policies

string

Snapshot policy for Cloudera Manager Service.

Returned: optional

tags

list / elements=string

List of tags for Cloudera Manager Service.

Returned: optional

type

string

The Cloudera Manager service type.

Returned: optional

Authors

  • Ronald Suplina (@rsuplina)

Collection links