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 |
---|---|
Set the HTTP user agent header when interacting with the CM API endpoint. Default: |
|
The role configuration to set. To unset a parameter, use |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
The display name for this role config group. |
|
Flag to force TLS during CM API endpoint discovery. If Choices:
|
|
Hostname of the CM API endpoint. If set, the Mutually exclusive with url. |
|
Message to log for any changes to the entity. Default: |
|
Password for access to the CM API endpoint. This parameter is set to |
|
Port of the CM API endpoint. If set, CM API endpoint discovery will connect to the designated port first and will follow redirects. Default: |
|
Set the HTTP/S proxy server when interacting with the CM API endpoint. |
|
Whether to reset configuration parameters to only the declared entries. Choices:
|
|
Path to SSL CA certificate to use for validation. |
|
The role type defining the role config group. |
|
The CM API endpoint URL and should include scheme, host, port, and API root path. Mutually exclusive with host. |
|
Username for access to the CM API endpoint. |
|
Verify the TLS certificates for the CM API endpoint. Choices:
|
|
API version of the CM API endpoint. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
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 |
---|---|
A Cloudera Manager service role config group. Returned: always |
|
Whether the role config group is a base group. Returned: always |
|
Set of configurations for the role config group. Returned: optional |
|
Display name of the role config group. Returned: always |
|
Name (identifier) of the role config group. Returned: always |
|
List of role names (identifiers) associated with this role config group. Returned: optional |
|
The type of the roles in this role config group. Returned: always |
|
Service name associated with this role config group. Returned: always |