cloudera.cluster.cm_service lookup – Get the details for a service on a CDP Datahub cluster

Note

This lookup plugin is part of the cloudera.cluster collection (version 4.4.0).

To install it, use: ansible-galaxy collection install cloudera.cluster.

To use it in a playbook, specify: cloudera.cluster.cm_service.

Synopsis

  • Allows you to retrieve the name or full details for a given service on a CDP Datahub cluster.

  • If no service name is found on the specified cluster, the lookup returns the value of default.

  • Otherwise, the lookup entry will be an empty list.

  • If the cluster is not found or is ambigious, the lookup will return an error.

  • If the Cloudera Manager endpoint is not found or is not available, the lookup will return an error.

Terms

Parameter

Comments

Terms

string / required

A service or list of services to lookup within the CDP Datahub cluster.

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('cloudera.cluster.cm_service', key1=value1, key2=value2, ...) and query('cloudera.cluster.cm_service', key1=value1, key2=value2, ...)

Parameter

Comments

agent_header

string

Header string to identify the connection.

Default: "cm_service"

cluster

string / required

Name of the Datahub cluster to query.

debug

boolean

Whether to log the urllib connection details.

Choices:

  • false ← (default)

  • true

default

any

Value to return if no service is found on the cluster.

detailed

boolean

Whether to return the full details of the service or just the name.

Choices:

  • false ← (default)

  • true

endpoint

string

API endpoint of Cloudera Manager.

force_tls

boolean

Whether to force the HTTPS scheme when discovering the Cloudera Manager API endpoint.

Ignored if endpoint is defined.

Choices:

  • false

  • true ← (default)

host

string

Hostname when discovering the Cloudera Manager API endpoint.

Ignored if endpoint is defined.

password

string / required

Password for accessing the Cloudera Manager API.

Configuration:

port

integer

Port when discovering the Cloudera Manager API endpoint.

Ignored if endpoint is defined.

Default: 7183

username

string / required

Username for accessing the Cloudera Manager API.

Configuration:

verify_tls

boolean

Whether to verify the TLS credentials of the Cloudera Manager API endpoint.

Choices:

  • false

  • true ← (default)

version

string

Version of the Cloudera Manager API.

Notes

Note

  • When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters: lookup('cloudera.cluster.cm_service', term1, term2, key1=value1, key2=value2) and query('cloudera.cluster.cm_service', term1, term2, key1=value1, key2=value2)

  • Requires cm_client.

Authors

  • Webster Mudge (@wmudge)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

Collection links