Chapter 4. Managing Subscriptions

Red Hat Satellite 6 imports content from the Red Hat Content Delivery Network (CDN). A subscription manifest is used to find, access, and download content from the corresponding repositories. You must have a subscription manifest containing a subscription allocation for each organization on your Satellite Server. All subscription information is available in your Red Hat Customer Portal account.

Use this chapter to create, modify, and refresh subscription allocations and manifests.

4.1. Managing Subscription Allocations

4.1.1. Creating a Subscription Allocation in the Customer Portal

You can access your subscription information in the Red Hat Customer Portal and create a subscription allocation. You can then export the allocation as a subscription manifest for use in on-premise management applications, such as Red Hat Satellite.

Procedure

  1. Open the Red Hat Customer Portal in your browser and log in to your Red Hat account.
  2. Navigate to Subscriptions, which is in the upper-left corner of the Customer Portal page.
  3. Click the Subscription Allocations tab.
  4. Click New Subscription Allocation.
  5. In the Name field, enter a descriptive name that helps identify the subscription allocation.
  6. From the Type list, select the type and version that corresponds to your Satellite Server.
  7. Click Create.
  8. After a few minutes, the web UI reports that the allocation has been successfully created.

4.1.2. Adding Subscriptions to a Subscription Allocation

If you want to add additional Red Hat products or future-dated subscriptions for existing products, you must add the relevant subscriptions to your subscription allocation. The following procedure explains how to add subscriptions to a subscription allocation.

Procedure

  1. Open the Red Hat Customer Portal in your browser and log in to your Red Hat account.
  2. Navigate to Subscriptions, which is in the upper-left corner of the Customer Portal page.
  3. Click the Subscription Allocations tab.
  4. From the Name column, select the name of the subscription allocation you want to modify.
  5. Click the Subscriptions tab, and then click Add Subscriptions.
  6. On the row of each subscription you want to add, enter the quantity under the Entitlements column.
  7. Click Submit.
  8. If the modified subscription allocation has a corresponding subscription manifest on a Satellite Server, refresh the subscription manifest. For more information, see Section 4.2.5, “Updating and Refreshing Subscription Manifests”.

4.1.3. Removing Subscriptions from a Subscription Allocation

The following procedure explains how to remove subscriptions from a subscription allocation, for example, if you want to remove expired subscriptions.

Procedure

  1. Open the Red Hat Customer Portal in your browser and log in to your Red Hat account.
  2. Navigate to Subscriptions, which is in the upper-left corner of the Customer Portal page.
  3. Click the Subscription Allocations tab.
  4. From the Name column, select the name of the subscription allocation you want to modify.
  5. Click the Subscriptions tab.
  6. On the row of each subscription you want to remove, select the corresponding check box.
  7. Click Remove, and then confirm removal.
  8. If the modified subscription allocation has a corresponding subscription manifest on a Satellite Server, refresh the subscription manifest. For more information, see Section 4.2.5, “Updating and Refreshing Subscription Manifests”.

4.1.4. Moving Subscriptions between Subscription Allocations

The following procedure explains how to move subscriptions from one subscription allocation to another.

Procedure

  1. Open the Red Hat Customer Portal in your browser and log in to your Red Hat account.
  2. Navigate to Subscriptions, which is in the upper-left corner of the Customer Portal page.
  3. Click the Subscription Allocations tab.
  4. From the Name column, select the name of the subscription allocation you want to modify.
  5. Click the Subscriptions tab.
  6. On the row of each subscription you want to move, select the corresponding check box.
  7. Click Move to Another Allocation.
  8. In the "Move entitlements from this subscription allocation to another" window, use the appropriate method to select the subscriptions you want to move:

    • If you want to select all subscriptions, select Move All Entitlements.
    • If you want to specify quantities, enter the appropriate quantity on the row of each subscription under the Quantity to Move column.
    • If you want to remove a subscription from the selection, click the delete icon on the row of that subscription, and then click OK to confirm.
  9. Click Next: Select Destination Allocation.
  10. From the table, select the subscription allocation you want to move the subscriptions to, and then click Submit.
  11. If the modified subscription allocation has a corresponding subscription manifest on a Satellite Server, refresh the subscription manifest. For more information, see Section 4.2.5, “Updating and Refreshing Subscription Manifests”.

4.1.5. Using Future Dated subscriptions

You can use future-dated subscriptions in a subscription allocation. When you add future-dated subscriptions to content hosts before the expiry date of the existing subscriptions, you can have uninterrupted access to repositories.

Red Hat recommends that you manually attach the future-dated subscriptions to your content hosts before the current subscriptions expire and not to rely on the auto-attach method. For more information, see Section 4.2.2, “Attaching Subscriptions to Content Hosts”.

4.1.6. Using Subscription Allocations to Manage Multiple Organizations

You can manage more than one organization if you have more than one subscription allocation. Satellite 6 requires a single allocation for each organization configured in your Satellite Server. The advantage of this is that each organization maintains completely separate subscriptions so that you can support multiple organizations, each with their own Red Hat accounts.

4.1.7. Exporting a Subscription Manifest from the Customer Portal

When viewing a subscription allocation that has at least one subscription, you can export the allocation as a subscription manifest.

A subscription manifest is a ZIP archive of the subscription allocation, containing encoded subscriptions, which can be imported into your Satellite Server.

Procedure

  1. Open https://access.redhat.com/ in your browser and log in to your Red Hat account.
  2. Navigate to Subscriptions, which is in the upper-left corner of the Customer Portal page.
  3. Click the Subscription Allocations tab.
  4. From the Name column, select the name of the subscription allocation you want to export.
  5. On the Details pane, click Export Manifest to download the subscription manifest file.

4.1.8. Importing a Subscription Manifest into Satellite Server

The following procedure explains how to import a Subscription Manifest into your Satellite Server.

Prerequisite

You must have a subscription manifest file previously exported from the Customer Portal. For more information, see Section 4.1.7, “Exporting a Subscription Manifest from the Customer Portal”.

For Web UI Users

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Content > Subscriptions.
  3. On the Red Hat Subscriptions page, click Manage Manifest.
  4. In the Manage Manifest window, click Browse.
  5. Navigate to the location containing the subscription manifest file, and then click Open.
  6. If the Manage Manifest window does not close automatically, click Close to return to the Red Hat Subscriptions page.

For CLI Users

The Red Hat Satellite 6 CLI requires the manifest to be on your Satellite Server.

  1. Log in to your local client system, and then copy the subscription manifest file to your Satellite Server:

    [user@client ~]$ scp ~/manifest_file.zip root@satellite.example.com:~/.
  2. In a terminal, connect to your Satellite Server as the root user, and then import the subscription manifest file:

    [root@satellite ~]# hammer subscription upload \
    --file ~/manifest_file.zip \
    --organization "organization_name"

After a few minutes, the CLI reports a successful manifest import.

You can now enable repositories and import Red Hat content. For more information, see Chapter 5, Importing Red Hat Content.

4.2. Managing Subscription Allocations in the Satellite Web UI

With Red Hat Satellite 6.4, you can now manage your subscription allocations directly in the Satellite web UI.

4.2.1. Searching for a Subscription in the Satellite Web UI

When you import a subscription manifest into your Satellite Server, the subscriptions from your manifest are listed on the Red Hat Subscriptions page. If you have a high volume of subscriptions, you can filter the results to find a specific subscription.

Prerequisite

You must have a subscription manifest file previously imported to your Satellite Server. For more information, see Section 4.1.8, “Importing a Subscription Manifest into Satellite Server”.

Procedure

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Content > Subscriptions.
  3. On the Red Hat Subscriptions page, click the Search field to view the list search criteria for building your search query.
  4. Select a search criteria to display further options.
  5. When you have built your search query, click the search icon.

For example, if you place your cursor in the Search field, and select expires, then press the space bar, another list appears with the options of placing a >, <, or = characters. If you select, >, and press the space bar, another list of automatic options appear. You can also enter your own criteria.

4.2.2. Attaching Subscriptions to Content Hosts

Using activation keys is the recommended way to attach subscriptions to content hosts during provisioning. However, an activation key cannot update an existing host. If you need to attach new or additional subscriptions, such as future-dated subscriptions, to one host, follow the method below.

For more information about updating multiple hosts, see Section 4.2.6, “Bulk Updating Content Hosts' Subscriptions”.

For more information about activation keys, see Chapter 9, Managing Activation Keys.

Prerequisite

You must have a subscription manifest file previously imported to your Satellite Server. For more information, see Section 4.1.8, “Importing a Subscription Manifest into Satellite Server”.

Smart Management Subscriptions

In Satellite 6, the number of Red Hat Enterprise Linux Smart Management subscriptions correspond with how many systems Satellite can manage. You must maintain a Smart Management subscription for every Red Hat Enterprise Linux subscription that you want to manage with Satellite.

However, you are not required to attach Smart Management subscriptions to each content host. Smart Management subscriptions cannot attach automatically to content hosts in Satellite because they are not associated with any product certificates. Adding a Smart Management subscription to a content host does not provide any content or repository access. If you want, you can add a smart management subscription to a manifest for your own recording or tracking purposes.

For Web UI Users

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Hosts > Content Hosts.
  3. On the row of each content host whose subscription you want to change, select the corresponding check box.
  4. From the Select Action list, select Manage Subscriptions.
  5. Optionally, enter a key and value in the Search field to filter the subscriptions displayed.
  6. Select the check box to the left of the subscriptions to be added or removed and click Add Selected or Remove Selected as required.
  7. Click Done to save the changes.

For CLI Users

  1. In a terminal, connect to your Satellite Server as the root user, and then list the available subscriptions:

    # hammer subscription list \
    --organization-id 1
  2. Attach a subscription to the host:

    # hammer host subscription attach \
    --host host_name \
    --subscription-id subscription_id

4.2.3. Adding Subscriptions to Subscription Allocations in the Satellite Web UI

The following procedure explains how to add subscriptions to a subscription allocation in the Satellite web UI.

Prerequisite

You must have a subscription manifest file imported to your Satellite Server. For more information, see Section 4.1.8, “Importing a Subscription Manifest into Satellite Server”.

Procedure

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Content > Subscriptions.
  3. On the Red Hat Subscriptions page, click Add Subscriptions.
  4. On the row of each subscription you want to add, enter the quantity under the Quantity to Allocate column.
  5. Click Submit.

After a few minutes, the web UI reports that the action has been successful.

4.2.4. Removing Subscriptions from Subscription Allocations in the Satellite Web UI

The following procedure explains how to remove subscriptions from a subscription allocation in the Satellite web UI.

Note

Manifests must not be deleted. If you delete the manifest from the Red Hat Customer Portal or in the Satellite web UI, all of the entitlements for all of your content hosts will be removed.

Prerequisite

You must have a subscription manifest file imported to your Satellite Server. For more information, see Section 4.1.8, “Importing a Subscription Manifest into Satellite Server”.

Procedure

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Content > Subscriptions.
  3. On the row of each subscription you want to remove, select the corresponding check box.
  4. Click Delete, and then confirm deletion.

After a few minutes, the web UI reports that the action has been successful.

4.2.5. Updating and Refreshing Subscription Manifests

Every time that you change a subscription allocation, you must refresh the manifest to reflect these changes. For example, you must refresh the manifest if you take any of the following actions:

  • Renewing a subscription
  • Adjusting subscription quantities
  • Purchasing additional subscriptions

You can use refresh the manifest directly in the Satellite web UI. Alternatively, you can import an updated manifest that contains the changes. For more information about importing a manifest, see Section 4.1.8, “Importing a Subscription Manifest into Satellite Server”.

Procedure

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Content > Subscriptions.
  3. On the Red Hat Subscriptions page, click Manage Manifest.
  4. In the Manage Manifest window, click Refresh.

After a few minutes, the web UI reports that the action has been successful.

4.2.6. Bulk Updating Content Hosts' Subscriptions

The methods described here are intended for post installation changes to multiple content hosts at the same time. You can use the web UI and the filter function to select the content hosts to be changed, or use the Hammer command-line tool’s CSV file export function, edit the configuration settings in the CSV file, and upload the changes.

For Web UI Users

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. Navigate to Hosts > Content Hosts.
  3. On the row of each content host whose subscription you want to change, select the corresponding check box.
  4. From the Select Action list, select Manage Subscriptions.
  5. Optionally, enter a key and value in the Search field to filter the subscriptions displayed.
  6. Select the check box to the left of the subscriptions to be added or removed and click Add Selected or Remove Selected as required.
  7. Click Done to save the changes.

For CLI Users

  1. Export the current state of content hosts to a CSV file.

    # hammer --server https://satellite.example.com csv content-hosts --export --file content_hosts.csv
  2. Change the required values in the CSV file. You can use an editor, with a CSV plug-in, or sed to change strings in the CSV file.

    1. Make a backup of the file:

      # cp content_hosts.csv content_hosts.csv.backup
    2. Edit the string you want to change. For example:

      # sed -i "s/1|RH1234|Red Hat Enterprise Linux Server/1|RH5678|Red Hat Enterprise Linux Server/g" content_hosts.csv
    3. Confirm only the required changes were made. For example:

      # diff content_hosts.csv content_hosts.csv.backup
  3. Upload the changed file to Satellite Server:

    # hammer --server https://satellite.example.com csv content-hosts --file content_hosts.csv