Chapter 8. Client command-line options and configuration details

--help

-h

Display help information

--register

Register the host to Red Hat Lightspeed by using the information in /etc/hostname. Enables the nightly cron job unless --disable-schedule is set.

--unregister

Unregister the host from Red Hat Lightspeed.

--display-name=DISPLAY_NAME

Set or change the host display name in the GUI. Use it with the --register option to set the value of display_name during the host registration if you want to use a different name than the one specified in /etc/hostname. You can also use the --display-name option after registration to override the name shown for this host in Red Hat Lightspeed inventory.

--group=GROUP

Add a host to a GROUP during registration. Define Group names in /etc/insights-client/tags.yaml.

--retry=RETRIES

Set the number of times to retry an upload. The default is 1. The retry interval is 180 seconds, which is how long the insights-client waits until retrying the upload.

NOTE: In the scheduler, the number of retries is 3.

--validate

Validate /etc/insights-client/tags.yaml, /etc/insights-client/file-redaction.yaml, and /etc/insights-client/file-content-redaction.yaml files.

--quiet

Log only error messages to the terminal output.

--silent

Disable message logging to the terminal.

--enable-schedule

Enable the job schedule. By default, the insights-client runs daily, at or near midnight.

--disable-schedule

Disable the nightly job schedule.

--conf=CONF

-c=CONF

Use a custom configuration file by specifying a file path for CONF instead of using the default /etc/insights-client/insights-client.conf file.

IMPORTANT: This option is not available for RHEL 10 systems.

--no-upload

Runs the insights-client without uploading the archive to Red Hat Lightspeed. The archive is stored in the /var/tmp/ directory. When the command completes running, the file name displays.

--offline

Run the client without using network functionality. Using this command does not upload data to Red Hat Lightspeed, similar to using the --no-upload option.

--logging-file=LOGFILE

Write the log data to the specified log file, LOGFILE. The default log file is /var/log/insights-client/insights-client.log.

IMPORTANT: This option is not available for RHEL 10 systems.

--diagnosis Get diagnostic information from the API. The system must be registered and uploaded at least once to use the --diagnosis option.

--compliance

Scan the system with OpenSCAP and upload the report to the Red Hat Lightspeed compliance service in the Red Hat Hybrid Cloud Console.

--compliance-policies

List the policies available to assign to the system. The output also provides information for the following categories:

--compliance-assign

Assign the system to the policy by using the ID from the insights-client --compliance-policies output.

--compliance-unassign

Remove the system from the policy by using the ID from the insights-client --compliance-policies output.`

--payload=PAYLOAD

Upload a specific archive payload file to Red Hat Lightspeed. You must set --content-type.

--content-type=TYPE

Set the content type for the PAYLOAD option. The TYPE value can be gz, bz2, xz, or none. The value of TYPE must match the --compressor used with the payload file.

--show-results

Display analysis results by using the --check-results option.

--output-dir=DIR

Write the collection to a specified directory instead of uploading to Red Hat Lightspeed.

--output-file=FILE

Write the collection to a specified archive instead of uploading to Red Hat Lightspeed.

--ansible-host=ANSIBLE-HOST

Set or change the Ansible hostname in Red Hat Lightspeed inventory. Run this during registration to specify a different hostname from the one listed in /etc/hostname or the configuration file. This also overrides the hostname that Red Hat Lightspeed remediations injects into generated playbooks targeting the Ansible host.

--list-specs

Show insights-client collection specs.

--build-packagecache

Refresh the system package manager cache.

--manifest=MANIFEST

The specified manifest YAML file that defines what Red Hat Lightspeed Core should collect.

--checkin

Do a lightweight check-in instead of a full upload.

--collector=APPLICATION

Run the specified application and upload its generated archive.

For example, specify:

--version

Print the versions of insights-client Client and Core.

--test-connection

Test connectivity to the Red Hat Lightspeed services.

--verbose

Log all debug output to the console.

--no-upload

Run the client, but do not upload the archive. The client stores the archive in the /var/tmp/ directory. The file name displays when insights-client completes.

--keep-archive

Store the archive in the /var/cache/insights-client/ directory after upload.

--support

Generate a diagnostic log for support.

--status

Display host registration status.

--net-debug

Log network calls to the console.

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

Use this value to for the --display-name option for 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 processes terminate 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 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.