Section 8 · System administration

insights-client.8

Package: insights-client

insights-client

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
DEBUG OPTIONS
MOTD
LOGGING
SEE ALSO


NAME

insights−client − Red Hat Insights Client tool

SYNOPSIS

insights-client [options]

DESCRIPTION

insights−client is designed to help customers proactively resolve issues affecting business operations in Red Hat Enterprise Linux and Red Hat Cloud Infrastructure environments. View alerts or learn more at https://console.redhat.com/insights/. Due to the dynamic nature of this application, some options may become available that are not described in the manual. Please refer to the output of —help for the most up-to-date options, or view https://access.redhat.com/articles/4099591 for more details.

OPTIONS

-h, —help

Show this help message and exit.

—register

Register host to the Red Hat Insights service.

—unregister

Unregister host from the Red Hat Insights service.

—display-name=DISPLAYNAME

Display name to use for this host. May be used during registration.

—group=GROUP

Add a tag name group with the specified value to this host. The tag will be saved to the tags file.

—retry=RETRIES

Number of times to retry uploading. 180 seconds between tries.

—validate

Validate the contents of the denylist configuration.

—quiet

Only display error messages to stdout.

—silent

Display no messages to stdout.

—enable-schedule

Enable automatic scheduling.

—disable-schedule

Disable automatic scheduling.

—compressor

Specifies the compression algorithm to use. Choices are gz, bz2, xz, and none. Defaults to gz.

—offline

Collect locally only, do not connect to Insights and do not upload.

—payload=FILE

Skip collection and upload a specified archive. Requires —content-type.

—content-type=TYPE

Content type of the archive specified with —payload.

—diagnosis=ID

Retrieve a remediation for this system.

—compliance

Scan the system with OpenSCAP and upload the report.

—check-results

Retrieve analysis results from the Red Hat Insights service.

—show-results

Display analysis results from the Red Hat Insights service.

—output-dir=DIR

Write the collection to a specified directory. Does not perform an upload.

—output-file=FILE

Write the collection to a specified file. Does not perform an upload.

—checkin

Perform a lightweight hourly check-in.

—list-specs

Show insights-client collection specs.

—compliance

Run a Compliance scan and upload.

—module MODULE, -m MODULE

Run a module from within the insights.client package. Analogous to “python -m MODULE”. Use only as directed.

DEBUG OPTIONS

—version

Display version.

—test-connection

Test connectivity to Red Hat.

—verbose

DEBUG output to stdout

—no-upload

Do not upload the archive.

—keep-archive

Do not delete archive after upload.

—support

Create a support logfile for Red Hat Insights.

—status

Check this host’s registration status with Red Hat Insights.

—net-debug

Log network activity to console.

MOTD

A message will be displayed on login about insights−client if installed but has not yet been used at least once.

To change this message, edit the /etc/insights-client/insights-client.motd file.

To prevent this message to be shown on login, create the /etc/motd.d/insights-client symlink pointing to /dev/null.

LOGGING

insights−client utilizes the ’logrotate’ tool to rotate log files. To change log rotation options, edit the /etc/logrotate.d/insights-client file. Please refer to the ’logrotate’ tool documentation to see all available configuration options.

SEE ALSO

insights-client.conf(5)