Appendix A. Command options for insights-client
As a system administrator with root privileges, you can use the insights-client
command and its options to control the Insights client operation on your system. Because the insights-client.rpm
is updated less frequently than individual components in Insights for Red Hat Enterprise Linux, the man page might not include the most recent information about insights-client
.
Each time you enter the insights-client
command, the client collects data and sends it to Insights for Red Hat Enterprise Linux.
Using the insights-client --display-name
command to set the display name takes effect immediately, but does not run the Insights client.
A.1. Options for the Insights client
Option | Description |
---|---|
| Display help information |
|
Register the host to Insights for Red Hat Enterprise Linux by using the information in |
| Unregister the host from Insights for Red Hat Enterprise Linux. |
|
Set or change the host display name in the GUI. Use with |
|
Add host to GROUP during registration. Group names are defined in |
| 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 the |
| Only log error messages to the console. |
| Log nothing to the console. |
| Enable the job schedule. By default, the Insights client runs daily, at or near midnight.
NOTE: If you are using Client 1.x, use the |
| Disable the nightly job schedule. |
|
Use a custom configuration file CONF instead of the default |
|
Runs the client but does not upload the archive to Red Hat Insights. The archive is stored in the |
|
Run the client without using network functionality. Implies |
|
Output the log data to the specified log file ( |
|
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 |
| Scan the system with OpenSCAP and upload the report. |
| Lists all the policies that the system can be assigned to and provides useful information in the output table for the following categories:
|
|
Assigns the system to the policy by using the ID that is output from |
|
Unassigns the system from the policy by using the ID that is output from |
|
Upload a specific archive payload file to Red Hat Insights for Red Hat Enterprise Linux. Requires |
|
Set the content type for |
|
Display analysis results fetched by |
| Write the collection to a specified directory instead of uploading. |
| Write the collection to a specified archive instead of uploading. |
|
Set or change the Ansible hostname in Red Hat Insights inventory. Use this option during registration when you want to set a different name than the one specified in |
| Show insights-client collection specs. |
| Refresh the system package manager cache. |
| The specified manifest YAML file that defines what Insights Core should collect. |
| Do a lightweight check-in instead of a full upload. |
| Run the specified app and upload its results archive. For example, specify:
|
Additionally, use the following insights-client
command options when you need to debug Insights client operations:
Option | Description |
---|---|
|
Print the versions of |
| Test connectivity to the Red Hat Insights for Red Hat Enterprise Linux services. |
| Log all debug output to the console. |
|
Runs the client but does not upload the archive. The archive gets stored in the |
|
Store the archive in the |
| Generate a diagnostic log for support. |
| Display host registration status. |
| Log network calls to the console. |