cloudera.cluster.service_config_info module – Retrieve information about the configuration for a cluster service

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

Synopsis

  • Gather configuration information about a service 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

The service to examine.

If the service does not exist, the module will return an empty result.

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.

Choices:

  • "summary" ← (default)

  • "full"

Examples

---
- name: Gather the configuration details for a cluster service
  cloudera.cluster.service_config_info:
    host: "example.cloudera.host"
    username: "jane_person"
    password: "S&peR4Ec*re"
    cluster: ExampleCluster
    service: knox

- name: Gather the configuration details in 'full' for a cluster service
  cloudera.cluster.service_config_info:
    host: "example.cloudera.host"
    username: "jane_person"
    password: "S&peR4Ec*re"
    cluster: ExampleCluster
    service: ecs
    view: full

Return Values

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

Key

Description

config

list / elements=dictionary

Service-wide configuration details about a cluster service.

Returned: success

default

string

The default value.

Available using view=full.

Returned: when supported

description

string

A textual description of the parameter.

Available using view=full.

Returned: when supported

display_name

string

A user-friendly name of the parameters, as would have been shown in the web UI.

Available using view=full.

Returned: when supported

name

string

The canonical name that identifies this configuration parameter.

Returned: always

string

If applicable, contains the related configuration variable used by the source project.

Available using view=full.

Returned: when supported

required

boolean

Whether this configuration is required for the service.

If any required configuration is not set, operations on the service may not work.

Available using view=full.

Returned: when supported

sensitive

boolean

Whether this configuration is sensitive, i.e. contains information such as passwords, which might affect how the value of this configuration might be shared by the caller.

Returned: when supported

validation_message

string

A message explaining the parameter’s validation state.

Available using view=full.

Returned: when supported

validation_state

string

State of the configuration parameter after validation.

Available using view=full.

Returned: when supported

Sample: "['OK', 'WARNING', 'ERROR']"

validation_warnings_suppressed

boolean

Whether validation warnings associated with this parameter are suppressed.

In general, suppressed validation warnings are hidden in the Cloudera Manager UI.

Configurations that do not produce warnings will not contain this field.

Available using view=full.

Returned: when supported

value

string

The user-defined value.

When absent, the default value (if any) will be used.

Can also be absent, when enumerating allowed configs.

Returned: always

Authors

  • Webster Mudge (@wmudge)

Collection links