cloudera.cluster.role_config_group module – Manage a cluster 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.role_config_group.

New in cloudera.cluster 4.4.0

Synopsis

• Manage a cluster service role config group.

Aliases: 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"
cluster aliases: cluster_name string / required	The associated cluster.
config aliases: params, parameters dictionary	The role config group 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 in the Cloudera Manager UI.
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"
name aliases: role_config_group_name, role_config_group string	A role config group to manage. If not defined, the module will target the base role config group associated with the role_type.
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
role_type aliases: type string	The role type defining the role config group. To change the role_type of an existing role config group, you must explicitly delete and recreate the role config group.
service aliases: service_name string / required	The associated service.
skip_redacted aliases: redacted boolean	Flag indicating if the declared configuration parameters and tags should skipped REDACTED parameters during reconciliation. If set, the module will not attempt to update any existing parameter with a REDACTED value. Otherwise, the parameter value will be overridden. Choices: false ← (default) true
ssl_ca_cert aliases: tls_cert, ssl_cert path	Path to SSL CA certificate to use for validation.
state string	The presence or absence of the role config group. If any roles are associated with role config group, you are not able to delete the group. NOTE: you cannot remove a base role config group. Choices: "present" ← (default) "absent"
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.role_config_group_info

Retrieve information about a cluster service role config group or groups.

Examples

- name: Create or update a role config group
  cloudera.cluster.role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: ZooKeeper
    name: Example-ZK-Server
    type: SERVER
    config:
      tickTime: 2500

- name: Create or update a role config group, purging undeclared parameters
  cloudera.cluster.role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: ZooKeeper
    name: Example-ZK-Server
    type: SERVER
    config:
      another_parameter: 12345
    purge: true

- name: Update the base role config group for a role type
  cloudera.cluster.role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: ZooKeeper
    # name: Leave blank to target the base role config group
    type: SERVER
    config:
      tickTime: 3500

- name: Reset the configuration of a role config group
  cloudera.cluster.role_config_group:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    cluster: example-cluster
    service: ZooKeeper
    name: Example-ZK-Server
    type: SERVER
    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 service role config group. Returned: always
base boolean	Flag indicating whether this is a base group. Returned: always
cluster_name string	The cluster name associated with the service of the role config group. Returned: always
config dictionary	Set of configurations for the role config group. Returned: when supported
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

• Issue Tracker
• Repository (Sources)
• Submit a Bug Report
• Request a Feature