Appendix A. Command options for insights-client

--help

-h

Display help information

--register

Register the host to Red Hat Lightspeed by using the information in /etc/hostname. Will automatically enable 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 with --register to set the value of display_name when the host is registered 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 host to GROUP during registration. Group names are defined 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 Red Hat Lightspeed 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

Only log error messages to the console.

--silent

Log nothing to the console.

--enable-schedule

Enable the job schedule. By default, the Red Hat Lightspeed client runs daily, at or near midnight.

NOTE: If you are using Client 1.x, use the --register option to enable the schedule.

--disable-schedule

Disable the nightly job schedule.

--conf=CONF

-c=CONF

Use a custom configuration file CONF instead of the default /etc/insights-client/insights-client.conf file.

NOTE: This option is NOT available for RHEL 10 systems.

--no-upload

Runs the client but does not upload the archive to Red Hat Lightspeed. The archive is stored in the /var/tmp/ directory. The file name displays when the insights-client command completes.

--offline

Run the client without using network functionality. Implies --no-upload.

--logging-file=LOGFILE

Output the log data to the specified log file (LOGFILE). The default log file is /var/log/insights-client/insights-client.log

NOTE: This option is NOT available for RHEL 10 systems.

--diagnosis

Fetch diagnostic information from the API. You need to ensure that the system has been registered and uploaded at least once before you can use --diagnosis.

--compliance

Scan the system with OpenSCAP and upload the report.

--compliance-policies

Lists all the policies that the system can be assigned to and provides useful information in the output table for the following categories:

--compliance-assign

Assigns the system to the policy by using the ID that is output from insights-client --compliance-policies.

--compliance-unassign

Unassigns the system from the policy by using the ID that is output from insights-client --compliance-policies.

--payload=PAYLOAD

Upload a specific archive payload file to Red Hat Lightspeed. Requires --content-type to be set.

--content-type=TYPE

Set the content type for PAYLOAD. Type 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 fetched by --check-results.

--output-dir=DIR

Write the collection to a specified directory instead of uploading.

--output-file=FILE

Write the collection to a specified archive instead of uploading.

--ansible-host=ANSIBLE_HOST

Set or change the Ansible hostname in Red Hat Lightspeed inventory. Use this option during registration when you want to set a different name than the one specified in /etc/hostname or the configuration file. You can also use this option to override the hostname injected into playbooks targeting this host as generated by Red Hat Lightspeed remediations.

--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=APP

Run the specified app and upload its results 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

Runs the client but does not upload the archive. The archive gets stored 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.