cloudera.cluster.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 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_info
.
New in cloudera.cluster 4.4.0
Synopsis
Gather details about a role config group or groups of a service in a CDP cluster.
Aliases: service_role_config_group_info
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 associated cluster. |
|
Capture the HTTP interaction logs with the CM API endpoint. Choices:
|
|
Flag to force TLS during CM API endpoint discovery. If Choices:
|
|
Hostname of the CM API endpoint. If set, the Mutually exclusive with url. |
|
The role config group to examine. If defined, the module will return the role config group. If the role config group does not exist, the module will return an empty result. Mutually exclusive with |
|
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. |
|
The associated service. |
|
Path to SSL CA certificate to use for validation. |
|
The role type defining the role config group(s). If specified, will return all role config groups for the type. Mutually exclusive with |
|
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.role_config_group
Manage a cluster service role config group.
Examples
- name: Gather the configuration details for all role config groups for a service
cloudera.cluster.role_config_group_info:
host: "example.cloudera.internal"
username: "jane_person"
password: "S&peR4Ec*re"
cluster: ExampleCluster
service: knox
- name: Gather the configuration details for a base role config group
cloudera.cluster.role_config_group_info:
host: "example.cloudera.internal"
username: "jane_person"
password: "S&peR4Ec*re"
cluster: ExampleCluster
service: knox
type: GATEWAY
- name: Gather the configuration details for a custom role config group
cloudera.cluster.role_config_group_info:
host: "example.cloudera.internal"
username: "jane_person"
password: "S&peR4Ec*re"
cluster: ExampleCluster
service: knox
name: custom_rcg_knox_gateway
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of cluster service role config groups. Returned: always |
|
Flag indicating whether this is a base role config group. Returned: always |
|
A user-friendly name of the role config group, as would have been shown in the web UI. Returned: when supported |
|
Name (identifier) of the role config group. Returned: always |
|
List of role names (identifiers) associated with this role config group. Returned: when supported |
|
The type of the roles in this role config group. Returned: always |
|
The service name associated with this role config group. Returned: always |