Search
SupportConsoleDevelopersStart a trialContact

Chapter 12. Configuring host collections

download PDF

A host collection is a group of content hosts. This feature enables you to perform the same action on multiple hosts at once. These actions can include the installation, removal, and update of packages and errata, change of assigned lifecycle environment, and change of content view. You can create host collections to suit your requirements, and those of your company. For example, group hosts in host collections by function, department, or business unit.

12.1. Creating a host collection

The following procedure shows how to create host collections.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Click New Host Collection.
  3. Add the Name of the host collection.
  4. Clear Unlimited Content Hosts, and enter the desired maximum number of hosts in the Limit field.
  5. Add the Description of the host collection.
  6. Click Save.

CLI procedure

  • To create a host collection, enter the following command: 

    # hammer host-collection create \
--name "My_Host_Collection" \
--organization "My_Organization"

12.2. Cloning a host collection

The following procedure shows how to clone a host collection.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. On the left hand panel, click the host collection you want to clone.
  3. Click Copy Collection.
  4. Specify a name for the cloned collection.
  5. Click Create.

12.3. Removing a host collection

Use the following procedure to remove a host collection from Satellite.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Select the host collection that you want to remove.
  3. Under Select Action, click Remove.
  4. Click Delete to remove the host collection.

12.4. Adding a host to a host collection

You can add a host to a host collection in the Satellite web UI.

Prerequisites

A host must be registered to Red Hat Satellite to add it to a Host Collection. For more information about registering hosts, see Section 4.3, “Registering hosts by using global registration”.

Note that if you add a host to a host collection, the Satellite auditing system does not log the change.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts.
  2. Click the name of the host you want to modify.
  3. In the Host collections card, click the vertical ellipsis and select Add host to collections.
  4. Select the host collection.
  5. Click Add.

CLI procedure

  • To add a host to a host collection, enter the following command: 

    # hammer host-collection add-host \
--host-ids My_Host_ID_1 \
--id My_Host_Collection_ID

12.5. Adding hosts to a host collection in bulk

You can add multiple hosts to a host collection.

Prerequisites

A host must be registered to Red Hat Satellite to add it to a host collection. For more information about registering hosts, see Section 4.3, “Registering hosts by using global registration”.

Note that if you add a host to a host collection, the Satellite auditing system does not log the change.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Select the host collection where the host should be added.
  3. On the Hosts tab, select the Add subtab.
  4. Select the hosts to be added from the table and click Add Selected.

CLI procedure

  • To add multiple hosts to a host collection, enter the following command: 

    # hammer host-collection add-host \
--host-ids My_Host_ID_1,My_Host_ID_2 \
--id My_Host_Collection_ID

12.6. Removing a host from a host collection

The following procedure shows how to remove hosts from host collections.

Note that if you remove a host from a host collection, the host collection record in the database is not modified so the Satellite auditing system does not log the change.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Choose the desired host collection.
  3. On the Hosts tab, select the List/Remove subtab.
  4. Select the hosts you want to remove from the host collection and click Remove Selected.

12.7. Adding content to a host collection

These steps show how to add content to host collections in Red Hat Satellite.

12.7.1. Adding packages to a host collection

The following procedure shows how to add packages to host collections.

Prerequisites

  • The content to be added should be available in one of the existing repositories or added prior to this procedure.
  • Content should be promoted to the environment where the hosts are assigned.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Select the host collection where the package should be added.
  3. On the Collection Actions tab, click Package Installation, Removal, and Update.
  4. To update all packages, click Update All Packages to use the default method. Alternatively, select the drop-down icon to the right of the button to select a method to use. Selecting the via remote execution – customize first menu entry will take you to the Job invocation page where you can customize the action.
  5. Select the Package or Package Group radio button as required.

  6. In the field provided, specify the package or package group name. Then click:

    • Install – to install a new package using the default method. Alternatively, select the drop-down icon to the right of the button and select a method to use. Selecting the via remote execution – customize first menu entry will take you to the Job invocation page where you can customize the action.
    • Update – to update an existing package in the host collection using the default method. Alternatively, select the drop-down icon to the right of the button and select a method to use. Selecting the via remote execution – customize first menu entry will take you to the Job invocation page where you can customize the action.

12.7.2. Viewing installed packages

Use the following procedure to view the installed packages of a host.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts and select the name of the host.
  2. On the Content tab, Packages displays a list of installed packages.

  3. To see details of a package, select that package.

    • The Details tab displays details of the selected package.
    • The Files tab lists the files contained in the package.
    • The Dependencies tab lists the dependencies of the package.
    • The Repositories tab lists the repositories that contain the selected package.
  4. You can filter these by Library or Default organization.

12.7.3. Upgrading a package

Use the following procedure to view the installed packages of a host.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts and select the name of the host that contains the package you want to upgrade.

  2. On the Content tab, select Packages.

    The Status column displays whether the package is upgradable or Up-to date. You cannot update an up-to-date package.

  3. From the list of packages, choose the package you want to upgrade and click the vertical ellipsis icon at the end of the line.
  4. Choose the Apply via Remote Execution to use Remote Execution, or Apply via customized remote execution if you want to customize the remote execution, for example, to set a time when it should be applied.
  5. Click Submit to upgrade the package.

12.7.4. Removing a package from a host

Use the following procedure to remove an installed package from a host.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts and select the host containing the package you want to remove.
  2. On the Content tab, select Packages.
  3. Click the vertical ellipsis icon at the end of the line for the package you want to remove, and choose the Remove option.
  4. Click Submit.

12.7.5. Adding errata to a host collection

The following procedure shows how to add errata to host collections.

Prerequisites

  • The errata to be added should be available in one of the existing repositories or added prior to this procedure.
  • Errata should be promoted to the environment where the hosts are assigned.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collections.
  2. Select the host collection where the errata should be added.
  3. On the Collection Actions tab, click Errata Installation.
  4. Select the errata you want to add to the host collection and click Install Selected to use the default method. Alternatively, select the drop-down icon to the right of the button to select a method to use. Selecting the via remote execution – customize first menu entry takes you to the Job invocation page where you can customize the action.

12.7.6. Adding errata to a single host

Use the following procedure to add errata to a host.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts.
  2. Select the host you want to add errata to.
  3. Click Content and select the Errata tab.
  4. Select the errata you want to add to the host, or select the checkbox at the top of the list to add all installable errata. Click the checkbox next to any errata you wish to remove from a full list.
  5. Using the vertical ellipsis icon next to the errata you want to add to the host, select Apply via Remote Execution to use Remote Execution, or select Apply via customized remote execution if you want to customize the remote execution.
  6. Click Submit.

12.7.7. Applying installable errata

Use the following procedure to view a list of installable errata and select errata to install.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts and select the host you require.
  2. If there are errata associated with the host, they are displayed in an Installable Errata card on the new Host page.
  3. On the Content tab, Errata displays installable errata for the chosen host.
  4. Click the checkbox for any errata you wish to install.
  5. Using the vertical ellipsis icon next to the errata you want to add to the host, select Apply via Remote Execution to use Remote Execution. Select Apply via customized remote execution if you want to customize the remote execution.
  6. Click Submit.

12.7.8. Filter errata by type and severity

Use the following procedure to filter errata by type or severity.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts and click the name of the host.
  2. On the Contents tab, Errata lists the errata associated with the selected host.
  3. Click Type to filter errata by type.
  4. You can filter to display errata of type Security, Bugfix, or Enhancement
  5. Click Severity to filter by severity.
  6. You can filter to display errata of severity N/A, Low, Moderate, Important, or Critical.
  7. To deselect your choice, return to the list of options and click the selected option again.

You can also use the Errata card on the host page to pre-filter errata for type before display.

12.7.9. Viewing errata by applicable and installable

Use the following procedure to view errata by applicable or installable.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts.
  2. Select the host name.
  3. Click the Overview tab. Under the Errata card, there are two types of Errata.
  4. Click Applicable to view errata that apply to a package installed on your host.
  5. Click Installable to view applicable errata that are available in the host content view and lifecycle environment.
  6. Click the link with number of errata under each type to see the list of all available errata of that type.
  7. Click security advisories, bug fixes, or enhancements under each type to view only the respective type of errata.

12.7.10. Generating a report for installable and applicable errata

Use the following procedure to generate a report of installable or applicable errata on hosts.

Procedure

  1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates.
  2. Click Generate for the Host – Applicable Errata template.
  3. Optional: To schedule a report, click the calendar icon to the right of the Generate at field and choose the date and time you want for the generated report.
  4. Optional: To send a report to an e-mail address, select the Send report via e-mail checkbox, and in the Deliver to e-mail addresses field, enter the required e-mail address.
  5. Optional: Select another Output format for the report file. The default is CSV.
  6. Optional: To limit the report only to hosts found by the search query, click on Hosts filter and search from the available list of hosts. For a report on all available hosts, leave Hosts filter empty.
  7. Optional: To limit the report only to errata found by the search query, click on Errata filter and search from the available list of errata. For a report on all available errata, leave Errata filter empty.

  8. From the Installability list, select one of these options:

    • Applicable to show all applicable errata.
    • Installable to limit the report exclusively to errata that are accessible in the content view environments of your host that may be installed.
  9. Click Generate. Your browser automatically downloads the report file after Satellite creates it. If you have selected the Send report via e-mail option, the report is sent to your e-mail address.

12.7.11. Removing content from a host collection

The following procedure shows how to remove packages from host collections.

Procedure

  1. Click Hosts > Host Collections.
  2. Click the host collection where the package should be removed.
  3. On the Collection Actions tab, click Package Installation, Removal, and Update.
  4. Select the Package or Package Group radio button as required.
  5. In the field provided, specify the package or package group name.
  6. Click Remove to remove the package or package group using the default method. Alternatively, select the drop-down icon to the right of the button and select a method to use. Selecting the via remote execution - customize first menu entry will take you to the Job invocation page where you can customize the action.

12.7.12. Changing the lifecycle environment or content view of a host collection

The following procedure shows how to change the assigned lifecycle environment or content view of host collections.

Procedure

  1. In the Satellite web UI, navigate to Hosts > Host Collection.
  2. Selection the host collection where the lifecycle environment or content view should be changed.
  3. On the Collection Actions tab, click Change assigned Lifecycle Environment or Content View.
  4. Select the lifecycle environment to be assigned to the host collection.
  5. Select the required content view from the list.

  6. Click Assign.

    Note

    The changes take effect in approximately 4 hours. To make the changes take effect immediately, on the host, enter the following command: 

    # subscription-manager refresh

    You can use remote execution to run this command on multiple hosts at the same time.

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.