cloudera.cluster.service_config module – Manage a service configuration in 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_config.

Synopsis

• Manage a service configuration (service-wide) in a 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 associated cluster.
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.
message aliases: msg string	Message to log for any changes to the entity. Default: "Managed by Ansible"
parameters aliases: params dictionary / required	The service-wide configuration to set. To unset a parameter, use None as the value.
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.
purge boolean	Set all parameters to either their default or declared values. Choices: false ← (default) true
service aliases: service_name, name string / required	The service to manage.
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"

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
platform	Platforms: all	Target OS/families that can be operated against

Examples

- name: Update (append) several service-wide parameters
  cloudera.cluster.service_config:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-service
    parameters:
      a_configuration: "schema://host:port"
      another_configuration: 234

- name: Reset a service-wide parameter
  cloudera.cluster.service_config:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-service
    parameters:
      some_conf: None

- name: Update (purge) service-wide parameters
  cloudera.cluster.service_config:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-service
    parameters:
      config_one: ValueOne
      config_two: 4567
    purge: yes

- name: Reset all service-wide parameters
  cloudera.cluster.service_config:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: example-service
    parameters: {}
    purge: yes

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
related_name 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

• Issue Tracker
• Repository (Sources)