Options for the insights-client configuration file

When the configuration file and the command line have similar options, the command-line option is executed when you enter the insights-client command. When the scheduler runs the client, the configuration file options are executed.

Note
You must enter the choices exactly as shown. True and False use initial capital letters.

The changes initiated by the options take effect either at the next scheduled run, or when you enter the insights-client command. Format the options as key=value pairs.

Table 1. insights-client.conf configuration options
Option Description

ansible_host

Use this option if you want a different hostname when running Ansible playbooks.

authmethod=CERT

Set the authentication method. The default value is CERT.

auto_config=True

Use this to auto configure with Satellite Server. Values can be True (default) or False.

NOTE: When auto_config=True (default), the authentication method used is CERT.

auto_update=True

Use this option to automatically update the dynamic configuration. The default value is True. Change the value to False if you do not want automatic updates.

base_url=cert-api.access.redhat.com:443/r/insights

Specify the base URL for the API.

cmd_timeout=120

Use this option to set the timeout limit for commands that run during collection. The value is measured in seconds. The command processes end when the timeout limit reaches the value of this option.

content_redaction_file

Omit lines or keywords from files and commands in the core collection. The core collection consists of a comprehensive set of data such as system logs, configuration files, and command outputs collected by the insights-client.

You do not need to change the default configuration. The content_redaction_file option uses the /etc/insights-client/file-content-redaction.yaml file by default.

display_name

Set the display name for the --display-name option during registration. The default is to use /etc/hostname.

NOTE: This value interacts with the insights-client --display-name command. If you use the command line to change the display name but the configuration file contains a different display name, the display name reverts to the configuration file value when the scheduler runs the insights-client.

http_timeout=120

Use this option to set the timeout limit for HTTP calls. The value is measured in seconds. The command stops the HTTP call when the timeout limit reaches the value.

[insights-client]

The configuration file must begin with this entry, even if you specify a custom path or name for the client configuration file.

loglevel=DEBUG

Use this option to change the log level. Values are: DEBUG, INFO, WARNING, ERROR, and CRITICAL. The default is DEBUG. The default log file location is /var/log/insights-client/insights-client.log.

obfuscation_list=<ipaddress_type>

Use this option to specify which IP connectivity protocol addresses to obfuscate in the data collection. By default, this value is not set and no data obfuscation occurs. Supported values are: IPv4, IPv6, hostname, and MAC. For example, to obfuscate the IP address (IPv6) and the hostname, set obfuscation_list=ipv6,hostname.

IMPORTANT: Remove deprecated obfuscate and obfuscate_hostname options from the configuration file. If your configuration file contains both obfuscation_list and deprecated options, the obfuscation_list takes precedence and insights-client displays a warning message in the output.

proxy

Use this option to set the URL for your proxy. Example: http://user:pass@192.168.100.50:8080

redaction_file

Use this option to omit files or commands from the core collection. The core collection consists of a comprehensive result set.

You do not need to change the default configuration. The redaction_file option uses /etc/insights-client/file-redaction.yaml by default.