Menu Close

Chapter 9. Installing the Satellite inventory upload plugin

If you are using Red Hat Satellite as the data collection tool, and you do not use Satellite plus Red Hat Insights to send data to the Cloud Services platform tools for processing, then you must install the Satellite inventory upload plugin to send this data.

You must also use the Satellite inventory upload plugin in combination with the virt-who tool for accurate reporting of hypervisor host-guest mapping information for virtual data center (VDC) subscriptions and similar virtualized environments.


In the following information, the actions that you do and the options that appear in the interface might vary according to your Satellite version.


Red Hat Satellite 6.7 or later (versions that are under full support)


  1. Install the Satellite inventory upload plugin on the Satellite Server.

    • For Satellite 6.8 and 6.9: The Satellite inventory upload plugin (rh_cloud) is installed for you during Satellite installation or upgrade unless it was explicitly disabled during the installation or upgrade process. In addition, for new installations of 6.9, the plugin is both installed and enabled by default.
    • For Satellite 6.7: Use the following command. This command runs the satellite-installer process and then restarts the Satellite services.

      # satellite-maintain packages install tfm-rubygem-foreman_rh_cloud
  2. Depending upon the Satellite version, you might have to activate the plugin to start automatic collection of data. To activate the plugin, click RH Inventory or RH Cloud in the navigation, and then enable the Allow Auto Upload option.

Verification steps

After a successful installation and restart (as needed per version), the RH Inventory or RH Cloud navigation option displays in the Red Hat Satellite interface, where you can view the status of the extract and upload actions.

Usage tips

When the auto upload option is enabled, the Satellite inventory upload plugin automatically reports once per day by default. You can also manually send data.

The Satellite inventory upload plugin includes reporting settings that you can use to address data privacy concerns. Use the Configure option in the Satellite navigation to configure the plugin to exclude certain packages, obfuscate host names, and obfuscate host addresses.

Additional resources

For more information about the satellite-maintain command and the extra package protection that was added to Satellite 6.6 and later, see the following Red Hat Customer Portal articles: