cloudera.cluster.cm_service_role_config_group module – Manage a Cloudera Manager Service role config group.

Note

This module is part of the cloudera.cluster collection (version 5.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cloudera.cluster 5.0.0

Synopsis

  • Manage a Cloudera Manager Service role config group.

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"

config

aliases: params, parameters

dictionary

The role configuration to set.

To unset a parameter, use None as the value.

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

display_name

string

The display name for this role config group.

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"

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

Whether to reset configuration parameters to only the declared entries.

Choices:

  • false ← (default)

  • true

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

type

aliases: role_type

string / required

The role type defining the role config group.

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"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

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

See Also

See also

cloudera.cluster.cm_service

Manage Cloudera Manager service.

cloudera.cluster.cm_service_role

Manage a Cloudera Manager Service role.

cloudera.cluster.cm_service_role_config_group_info

Retrieve information about Cloudera Management service role config groups.

Examples

- name: Update the configuration of a Cloudera Manager service role config group
  cloudera.cluster.cm_service_role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    type: HOSTMONITOR
    config:
      some_parameter: true

- name: Update the configuration of a Cloudera Manager service role config group, purging undeclared parameters
  cloudera.cluster.cm_service_role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    type: HOSTMONITOR
    config:
      another_parameter: 3456
    purge: true

- name: Reset the configuration of a Cloudera Manager service role config group
  cloudera.cluster.cm_service_role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    type: HOSTMONITOR
    purge: true

Return Values

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

Key

Description

role_config_group

dictionary

A Cloudera Manager service role config group.

Returned: always

base

boolean

Whether the role config group is a base group.

Returned: always

config

dictionary

Set of configurations for the role config group.

Returned: optional

display_name

string

Display name of the role config group.

Returned: always

name

string

Name (identifier) of the role config group.

Returned: always

role_names

list / elements=string

List of role names (identifiers) associated with this role config group.

Returned: optional

role_type

string

The type of the roles in this role config group.

Returned: always

service_name

string

Service name associated with this role config group.

Returned: always

Authors

  • Webster Mudge (@wmudge)