Search

Chapter 4. Configuring insights-client

download PDF

After you install Insights client, you must register your system with Red Hat Insights for Red Hat Enterprise Linux. Registration enables you to use Red Hat Insights for Red Hat Enterprise Linux services.

4.1. Registering your system with Red Hat Insights

You can use the insights-client command to register a system with Red Hat Insights.

As an option, you can assign a display name for your host when you register your system. The display name identifies the system in the Insights UI. If you do not assign a display name when you register the system, Insights uses the default hostname for the system.

Prerequisites

  • Root-level permissions for your system.
  • The Insights client is installed on your system.

Procedure

  1. Enter the insights-client command with the --register option.

    [root@insights]# insights-client --register
  2. Optional. To specify the display name for the system, include the --display-name option. For example:

    [root@insights]# insights-client --register --display-name ITC-4
    System display name changed from None to ITC-4

Verification

  • Enter the insights-client command with the --status option.

    [root@insights]# insights-client --status
    System is registered locally via .registered file. Registered at 2019-08-20T12:56:48.356814
    Insights API confirms registration.

You can now access the cloud-based Red Hat Insights for Red Hat Enterprise Linux services.

4.2. Unregistering your system with Insights

You can unregister your system with Red Hat Insights for Red Hat Enterprise Linux. When you do so, your system information is no longer uploaded to Insights for Red Hat Enterprise Linux.

Prerequisites

  • Root-level access to your system.
  • Your system is registered with Insights for Red Hat Enterprise Linux.

Procedure

  1. Enter the insights-client command with the --unregister option.

    [root@insights]# insights-client --unregister
    Successfully unregistered from the Red Hat Insights Service

Verification

  • Enter the insights-client command with the --status option.

    [root@insights]# insights-client --status
    System is NOT registered locally via .registered file. Unregistered at 2021-03-12T10:36:39.257300
    Insights API says this machine was unregistered at 2021-03-12T00:36:39.000Z

4.3. Re-registering your system with Red Hat Insights

To re-register systems in Red Hat Insights for Red Hat Enterprise Linux, and also avoid any duplicate host entries in the Insights inventory service after re-registering, run the insights-client command twice using two options:

  1. --unregister
  2. --register

Prerequisites

  • Root-level permissions for your system.
  • The Insights client is installed on your system.

Procedure

  1. Enter the insights-client command with the --unregister option.

    [root@insights]# insights-client --unregister
  2. Enter the insights-client command with the --register option.

    [root@insights]# insights-client --register

Verification

Successful implementation of the re-registration commands using insights-client command with the —-unregister option followed by the insights-client command with the —-register option results in the following message:

[root@insights]# Successfully uploaded report for <machine name>
View the Red Hat Insights console at https://console.openshiftusgov.com/insights/

4.4. Changing the host display name

You can change the host display name as it appears in the GUI. Make this change either when you register the system with Red Hat Insights for Red Hat Enterprise Linux, or after registration. If you do not assign a display name when you register the system, Red Hat Insights for Red Hat Enterprise Linux uses the value in /etc/hostname.

This procedure is optional. Determine if you want to use a display name in addition to the default hostname.

Note

Using the insights-client command to set the display name takes effect immediately, but does not run the Insights client.

Note

If you obfuscate the host name, the hostname configured in /etc/hostname is obfuscated. Assign a display name so that you can identify a host even when its hostname is obfuscated.

Prerequisites

  • Root-level access to the system.

Procedure

  • Enter the insights-client command with the --display-name option and specify a display name.

    [root@insights]# insights-client --display-name ITC-4
    System display name changed from None to ITC-4
  • To create a display name that contains spaces, use double quotes.

    [root@insights]# insights-client --display-name "ITC-4 B9 4th floor"
    System display name changed from None to ITC-4 B9 4th floor

4.5. Displaying the client version

You can display the client version and client core version.

Prerequisites

  • Root-level access to your system.

Procedure

  • Enter the insights-client command with the --version option.

    [root@insights]# insights-client --version
    Client: 3.0.6-0
    Core: 3.0.121-1
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.