cloudera.cluster.service_role_config_info module – Retrieve information about the configuration for a cluster service role
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_info
.
Synopsis
Gather configuration information about a service role of a CDP cluster.
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 cluster to examine. |
|
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. |
|
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 role to examine. If the role does not exist, the module will return an empty result. |
|
The service to examine. |
|
Path to SSL CA certificate to use for validation. |
|
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: |
|
The view to materialize. Choices:
|
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 |
---|---|
List of service role configurations. Returned: always |
|
The default value. Requires full view. Returned: when supported |
|
A textual description of the parameter. Requires full view. Returned: when supported |
|
A user-friendly name of the parameters, as would have been shown in the web UI. Requires full view. Returned: when supported |
|
The canonical name that identifies this configuration parameter. Returned: when supported |
|
If applicable, contains the related configuration variable used by the source project. Requires full view. Returned: when supported |
|
Whether this configuration is required for the object. If any required configuration is not set, operations on the object may not work. Requires full view. Returned: when supported |
|
Whether this configuration is sensitive, i.e. contains information such as passwords, which might affect how the value of this configuration might be shared by the caller. Returned: when supported |
|
State of the configuration parameter after validation. Requires full view. Returned: when supported |
|
A message explaining the parameter’s validation state. Requires full view. Returned: when supported |
|
Whether validation warnings associated with this parameter are suppressed. In general, suppressed validation warnings are hidden in the Cloudera Manager UI. Configurations that do not produce warnings will not contain this field. Requires full view. Returned: when supported |
|
The user-defined value. When absent, the default value (if any) will be used. Can also be absent, when enumerating allowed configs. Returned: when supported |
Authors
Webster Mudge (@wmudge)
Collection links