cloudera.cluster.service_role_config_group_info module – Retrieve information about a cluster service role config group or groups

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

Synopsis

  • Gather details about a role config group or groups of a service in 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 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.

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.

role_config_group

aliases: role_config_group, name

string / required

The role config group to examine.

If undefined, the module will return all role config groups for the service.

If the role config group does not exist, the module will return an empty result.

service

aliases: service_name

string / required

The associated service.

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"

Examples

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

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

Return Values

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

Key

Description

role_config_groups

list / elements=dictionary

List of service role config groups.

Returned: always

base

boolean

Flag indicating whether this is a base group.

Returned: always

display_name

string

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

Returned: when supported

name

string

The unique name of this role config group.

Returned: always

role_names

list / elements=string

List of role names associated with this role config group.

Returned: when supported

role_type

string

The type of the roles in this group.

Returned: always

service_name

string

The service name associated with this role config group.

Returned: always

Authors

  • Webster Mudge (@wmudge)

Collection links