cloudera.cluster.service_info module – Retrieve information about the services of cluster

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

Synopsis

  • Gather information about services of a CDP cluster.

Requirements

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

  • cm_client

Parameters

Parameter

Comments

agent_header

aliases: user_agent

string

Set the HTTP user agent header when interacting with the CM API endpoint.

Default: "ClouderaFoundry"

cluster

aliases: cluster_name

string / required

The cluster to examine.

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

force_tls

boolean

Flag to force TLS during CM API endpoint discovery.

If False, discovery will first try HTTP and follow any redirects.

Choices:

  • false ← (default)

  • true

host

aliases: hostname

string

Hostname of the CM API endpoint.

If set, the host parameter will trigger CM API endpoint discovery, which will follow redirects.

Mutually exclusive with url.

password

string / required

Password for access to the CM API endpoint.

This parameter is set to no_log.

port

integer

Port of the CM API endpoint.

If set, CM API endpoint discovery will connect to the designated port first and will follow redirects.

Default: 7180

proxy_server

aliases: proxy, http_proxy

string

Set the HTTP/S proxy server when interacting with the CM API endpoint.

service

aliases: service_name, name

string

A service to retrieve.

If absent, the module will return all services.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

url

aliases: endpoint, cm_endpoint_url

string

The CM API endpoint URL and should include scheme, host, port, and API root path.

Mutually exclusive with host.

username

aliases: user

string / required

Username for access to the CM API endpoint.

verify_tls

boolean

Verify the TLS certificates for the CM API endpoint.

Choices:

  • false

  • true ← (default)

version

aliases: api_version

string

API version of the CM API endpoint.

Default: "True"

view

string

The view to materialize.

healthcheck is the equivalent to full_with_health_check_explanation.

redacted is the equivalent to export_redacted.

Choices:

  • "summary" ← (default)

  • "full"

  • "healthcheck"

  • "export"

  • "redacted"

Examples

---
- name: Gather details of the services of a cluster
  cloudera.cluster.service_info:
    host: "example.cloudera.host"
    username: "jane_person"
    password: "S&peR4Ec*re"
    cluster: ExampleCluster

- name: Gather the details with additional healthcheck information for a service
  cloudera.cluster.service_info:
    host: "example.cloudera.host"
    username: "jane_person"
    password: "S&peR4Ec*re"
    cluster: ExampleCluster
    service: ecs
    view: healthcheck

Return Values

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

Key

Description

services

list / elements=dictionary

Details about the services of a cluster.

Returned: success

client_config_staleness_status

string

Status of the client configuration for the service.

Returned: always

Sample: "['FRESH', 'STALE_REFRESHABLE', 'STALE']"

cluster_name

string

The name of the cluster, which uniquely identifies it in a Cloudera Manager installation.

Returned: always

config_staleness_status

string

Status of configuration staleness for the service.

Returned: always

Sample: "['FRESH', 'STALE_REFRESHABLE', 'STALE']"

display_name

string

The display name for the service that is shown in the Cloudera Manager UI.

Returned: when supported

health_checks

list / elements=dictionary

Lists all available health checks for Cloudera Manager Service.

Returned: when supported

explanation

string

The explanation of this health check.

Returned: when supported

name

string

Unique name of this health check.

Returned: always

summary

string

The high-level health status of the health check.

Returned: always

Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"

suppressed

boolean

Whether this health check is suppressed.

A suppressed health check is not considered when computing the service’s overall health.

Returned: when supported

health_summary

string

The high-level health status of the service.

Returned: always

Sample: "['DISABLED', 'HISTORY_NOT_AVAILABLE', 'NOT_AVAILABLE', 'GOOD', 'CONCERNING', 'BAD']"

maintenance_mode

boolean

Whether the service is in maintenance mode.

Returned: when supported

maintenance_owners

list / elements=string

The list of objects that trigger this service to be in maintenance mode.

Returned: when supported

Sample: ["CLUSTER", "SERVICE", "ROLE", "HOST", "CONTROL_PLANE"]

name

string

The cluster service name.

Returned: always

service_state

string

State of the service.

Returned: always

Sample: "['HISTORY_NOT_AVAILABLE', 'UNKNOWN', 'STARTING', 'STARTED', 'STOPPING', 'STOPPED', 'NA']"

service_version

string

Version of the service.

Returned: when supported

tags

dictionary

The dictionary of tags for the service.

Returned: when supported

type

string

The cluster service type.

Returned: always

Sample: "['HDFS', 'HBASE', 'ECS']"

Authors

  • Webster Mudge (@wmudge)

Collection links