Managing hosts

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. On the Host tab, enter the required details.
3. Click the Ansible Roles tab, and from the Ansible Roles list, select one or more roles that you want to add to the host. Use the arrow icon to manage the roles that you add or remove.
4. On the Puppet Classes tab, select the Puppet classes you want to include.

5. On the Interfaces tab:

   1. For each interface, click Edit in the Actions column and configure the following settings as required:

      • Type — For a Bond or BMC interface, use the Type list and select the interface type.
      • MAC address — Enter the MAC address.
      • DNS name — Enter the DNS name that is known to the DNS server. This is used for the host part of the FQDN.
      • Domain — Select the domain name of the provisioning network. This automatically updates the Subnet list with a selection of suitable subnets.
      • IPv4 Subnet — Select an IPv4 subnet for the host from the list.
      • IPv6 Subnet — Select an IPv6 subnet for the host from the list.
      • IPv4 address — If IP address management (IPAM) is enabled for the subnet, the IP address is automatically suggested. Alternatively, you can enter an address. The address can be omitted if provisioning tokens are enabled, if the domain does not manage DNS, if the subnet does not manage reverse DNS, or if the subnet does not manage DHCP reservations.
      • IPv6 address — If IP address management (IPAM) is enabled for the subnet, the IP address is automatically suggested. Alternatively, you can enter an address.
      • Managed — Select this checkbox to configure the interface during provisioning to use the Capsule provided DHCP and DNS services.
      • Primary — Select this checkbox to use the DNS name from this interface as the host portion of the FQDN.
      • Provision — Select this checkbox to use this interface for provisioning. This means TFTP boot will take place using this interface, or in case of image based provisioning, the script to complete the provisioning will be executed through this interface. Note that many provisioning tasks, such as downloading packages by anaconda or Puppet setup in a %post script, will use the primary interface.

      • Virtual NIC — Select this checkbox if this interface is not a physical device. This setting has two options:

        • Tag — Optionally set a VLAN tag. If unset, the tag will be the VLAN ID of the subnet.
        • Attached to — Enter the device name of the interface this virtual interface is attached to.
   2. Click OK to save the interface configuration.
   3. Optionally, click Add Interface to include an additional network interface. For more information, see Chapter 5, Adding network interfaces.
   4. Click Submit to apply the changes and exit.
6. On the Operating System tab, enter the required details. For Red Hat operating systems, select Synced Content for Media Selection. If you want to use non Red Hat operating systems, select All Media, then select the installation media from the Media Selection list. You can select a partition table from the list or enter a custom partition table in the Custom partition table field. You cannot specify both.

7. On the Parameters tab, click Add Parameter to add any parameter variables that you want to pass to job templates at run time. This includes all Puppet Class, Ansible Playbook parameters and host parameters that you want to associate with the host. To use a parameter variable with an Ansible job template, you must add a Host Parameter.

   When you create a host, you can set system purpose attributes. System purpose attributes help determine which repositories are available on the host. System purpose attributes also help with reporting in the Subscriptions service of the Red Hat Hybrid Cloud Console. In the Host Parameters area, enter the following parameter names with the corresponding values. For the list of values, see Introduction to System Purpose in Performing a standard RHEL 8 installation.

   • syspurpose_role
   • syspurpose_sla
   • syspurpose_usage
   • syspurpose_addons

   If you want to create a host with pull mode for remote job execution, add the enable-remote-execution-pull parameter with type boolean set to true. For more information, see Section 13.4, “Transport modes for remote execution”.

8. On the Additional Information tab, enter additional information about the host.
9. Click Submit to complete your provisioning request.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. In the Actions menu, click Clone.
3. On the Host tab, ensure to provide a Name different from the original host.
4. On the Interfaces tab, ensure to provide a different IP address.
5. Click Submit to clone the host.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select a compute resource.
3. On the Virtual Machines tab, click Associate VM from the Actions menu.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. On the Overview tab, click Edit on the System purpose card.
4. Select the system purpose attributes for your host.
5. Click Save.

CLI procedure

1. Log in to the host and edit the required system purpose attributes. For example, set the usage type to Production, the role to Red Hat Enterprise Linux Server, and add the addon add on. For the list of values, see Introduction to System Purpose in Performing a standard RHEL 8 installation.

   # subscription-manager syspurpose set usage 'Production'
   # subscription-manager syspurpose set role 'Red Hat Enterprise Linux Server'
   # subscription-manager syspurpose add addons 'your_addon'

2. Verify the system purpose attributes for this host:

   # subscription-manager syspurpose

Procedure

1. In the Satellite web UI, navigate to Hosts > Content Hosts and select Red Hat Enterprise Linux 8 hosts that you want to edit.
2. Click the Select Action list and select Manage System Purpose.

3. Select the system purpose attributes that you want to assign to the selected hosts. You can select one of the following values:

   • A specific attribute to set an all selected hosts.
   • No Change to keep the attribute set on the selected hosts.
   • None (Clear) to clear the attribute on the selected hosts.
4. Click Assign.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. Click the Content tab, then click the Module streams tab.
4. Click the vertical ellipsis next to the module and select the action you want to perform. You get a REX job notification once the remote execution job is complete.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts and select a host.
2. Select the Content tab, then select Repository sets.
3. From the dropdown, you can filter the Repository type column to Custom.
4. Select the desired number of repositories or click the Select All checkbox to select all repositories, then click the vertical ellipsis, and select Override to Enabled.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. Click the vertical ellipsis icon next to the Edit button and select Change content source.
4. Select Content Source, Lifecycle Content View, and Content Source from the lists.

5. Click Change content source.

   Note

   Some lifecycle environments can be unavailable for selection if they are not synced on the selected content source. For more information, see Adding lifecycle environments to Capsule Servers in Managing content.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. On the Content view environment card, click the options icon and select Edit content view environments.
4. Select the environment.
5. Select the content view.
6. Click Save.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. Click Edit.
4. Click Manage host or Unmanage host to change the host’s status.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. On the Traces tab, click Enable Traces.
4. Select the provider to install katello-host-tools-tracer from the list.
5. Click Enable Tracer. You get a REX job notification after the remote execution job is complete.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the hosts you want to modify.
3. Select the Traces tab.
4. Select applications that you want to restart.
5. Select Restart via remote execution from the Restart app list. You will get a REX job notification once the remote execution job is complete.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select the checkbox of the host you want to change.
3. From the Select Action list, select Assign Organization. A new option window opens.

4. From the Select Organization list, select the organization that you want to assign your host to. Select the checkbox Fix Organization on Mismatch.

   Note

   A mismatch happens if there is a resource associated with a host, such as a domain or subnet, and at the same time not associated with the organization you want to assign the host to. The option Fix Organization on Mismatch will add such a resource to the organization, and is therefore the recommended choice. The option Fail on Mismatch will always result in an error message. For example, reassigning a host from one organization to another will fail, even if there is no actual mismatch in settings.

5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select the checkbox of the host you want to change.
3. From the Select Action list, select Assign Location. A new option window opens.

4. Navigate to the Select Location list and choose the location that you want for your host. Select the checkbox Fix Location on Mismatch.

   Note

   A mismatch happens if there is a resource associated with a host, such as a domain or subnet, and at the same time not associated with the location you want to assign the host to. The option Fix Location on Mismatch will add such a resource to the location, and is therefore the recommended choice. The option Fail on Mismatch will always result in an error message. For example, reassigning a host from one location to another will fail, even if there is no actual mismatch in settings.

5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > Content Hosts
2. Click the content host you want to view.
3. Select the Details tab to see the host details page.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click Manage columns.

3. Select columns that you want to display. You can select individual columns or column categories. Selecting or deselecting a category selects or deselects all columns in that category.

   Note

   Some columns are included in more than one category, but you can display a column of a specific type only once. By selecting or deselecting a specific column, you select or deselect all instances of that column.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts or Hosts > Content Hosts. Note that there is no difference from what page you remove a host, from All Hosts or Content Hosts. In both cases, Satellite removes a host completely.
2. Select the hosts that you want to remove.
3. From the Select Action list, select Delete Hosts.
4. Click Submit to remove the host from Satellite permanently.

Procedure

1. In the Satellite web UI, navigate to Configure > Host Groups and click Create Host Group.
2. If you have an existing host group that you want to inherit attributes from, you can select a host group from the Parent list. If you do not, leave this field blank.
3. Enter a Name for the new host group.
4. Enter any further information that you want future hosts to inherit.
5. Click the Ansible Roles tab, and from the Ansible Roles list, select one or more roles that you want to add to the host. Use the arrow icon to manage the roles that you add or remove.

6. Click the additional tabs and add any details that you want to attribute to the host group.

   Note

   Puppet fails to retrieve the Puppet CA certificate while registering a host with a host group associated with a Puppet environment created inside a Production environment.

   To create a suitable Puppet environment to be associated with a host group, manually create a directory:

   # mkdir /etc/puppetlabs/code/environments/example_environment

7. Click Submit to save the host group.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. Click Edit.
4. Select the host group from the Host Group list.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click the name of the host you want to modify.
3. Click Edit.
4. Select the new host group from the Host Group list.
5. Click Submit.

1. Manually create a directory:

   # mkdir /etc/puppetlabs/code/environments/example_environment

2. In the Satellite web UI, navigate to Configure > Puppet ENC > Environments.
3. Click Import environment from. The button name includes the FQDN of the internal or external Capsule.
4. Choose the created directory and click Update.

Procedure

1. Log in to the host as the root user.

2. Download the script:

   # curl -O http://satellite.example.com/pub/bootstrap.py

3. Make the script executable:

   # chmod +x bootstrap.py

4. Confirm that the script is executable by viewing the help text:

   • On Red Hat Enterprise Linux 8:

     # /usr/libexec/platform-python bootstrap.py -h

   • On other Red Hat Enterprise Linux versions:

     # ./bootstrap.py -h

5. Enter the bootstrap command with values suitable for your environment.

   For the --server option, specify the FQDN of Satellite Server or a Capsule Server. For the --location, --organization, and --hostgroup options, use quoted names, not labels, as arguments to the options. For advanced use cases, see Section 4.4.2, “Advanced bootstrap script configuration”.

   • On Red Hat Enterprise Linux 8, enter the following command:

     # /usr/libexec/platform-python bootstrap.py \
     --login=admin \
     --server satellite.example.com \
     --location="My_Location" \
     --organization="My_Organization" \
     --hostgroup="My_Host_Group" \
     --activationkey="My_Activation_Key"

   • On Red Hat Enterprise Linux 6 or 7, enter the following command:

     # ./bootstrap.py --login=admin \
     --server satellite.example.com \
     --location="My_Location" \
     --organization="My_Organization" \
     --hostgroup="My_Host_Group" \
     --activationkey="My_Activation_Key"

6. Enter the password of the Satellite user you specified with the --login option.

   The script sends notices of progress to stdout.

7. When prompted by the script, approve the host’s Puppet certificate. In the Satellite web UI, navigate to Infrastructure > Capsules and find the Satellite or Capsule Server you specified with the --server option.
8. From the list in the Actions column, select Certificates.
9. In the Actions column, click Sign to approve the host’s Puppet certificate.
10. Return to the host to see the remainder of the bootstrap process completing.
11. In the Satellite web UI, navigate to Hosts > All Hosts and ensure that the host is connected to the correct host group.

12. Optional: After the host registration is complete, remove the script:

    # rm bootstrap.py

Procedure

1. On the content host, install the katello-host-tools-tracer RPM package:

   # yum install katello-host-tools-tracer

2. Enter the following command:

   # katello-tracer-upload

3. In the Satellite web UI, navigate to Hosts > All Hosts, then click the required host name.
4. Click the Traces tab to view Traces. If it is not installed, an Enable Traces button initiates a remote execution job that installs the package.

Procedure

1. In the Satellite web UI, navigate to Configure > Global Parameters to add host parameters globally. Alternatively, you can navigate to Configure > Host Groups and edit or create a host group to add host parameters only to a host group.

2. Enable the Puppet agent using a host parameter in global parameters or a host group.

   Add a host parameter named enable-puppet7, select the boolean type, and set the value to true.

3. Specify configuration for the Puppet agent using the following host parameters in global parameters or a host group:

   • Add a host parameter named puppet_server, select the string type, and set the value to the hostname of your Puppet server, such as puppet.example.com.
   • Optional: Add a host parameter named puppet_ca_server, select the string type, and set the value to the hostname of your Puppet CA server, such as puppet-ca.example.com. If puppet_ca_server is not set, the Puppet agent will use the same server as puppet_server.
   • Optional: Add a host parameter named puppet_environment, select the string type, and set the value to the Puppet environment you want the host to use.

   Until the BZ2177730 is resolved, you must use host parameters to specify the Puppet agent configuration even in integrated setups where the Puppet server is a Capsule Server.

4. Navigate to Hosts > Register Host and register your host using an appropriate activation key. For more information, see Registering Hosts in Managing hosts.
5. Navigate to Infrastructure > Capsules.
6. From the list in the Actions column for the required Capsule Server, select Certificates.
7. Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

Procedure

1. Log in to the host as the root user.

2. Install the Puppet agent package.

   • On hosts running Red Hat Enterprise Linux 8 and above:

     # dnf install puppet-agent

   • On hosts running Red Hat Enterprise Linux 7 and below:

     # yum install puppet-agent

3. Add the Puppet agent to PATH in your current shell using the following script:

   . /etc/profile.d/puppet-agent.sh

4. Configure the Puppet agent. Set the environment parameter to the name of the Puppet environment to which the host belongs:

   # puppet config set server satellite.example.com --section agent
   # puppet config set environment My_Puppet_Environment --section agent

5. Start the Puppet agent service:

   # puppet resource service puppet ensure=running enable=true

6. Create a certificate for the host:

   # puppet ssl bootstrap

7. In the Satellite web UI, navigate to Infrastructure > Capsules.
8. From the list in the Actions column for the required Capsule Server, select Certificates.
9. Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

10. On the host, run the Puppet agent again:

    # puppet ssl bootstrap

Procedure

1. Create a host group with Ansible roles. For more information, see Section 3.2, “Creating a host group”.
2. Register the host by using the host group with assigned Ansible roles. For more information, see Section 4.3.3, “Registering a host”.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click Edit next to the host you want to edit.
3. On the Interfaces tab, click Add Interface.
4. Keep the Interface option selected in the Type list.
5. Specify a MAC address. This setting is required.
6. Specify the Device Identifier, for example eth0. The identifier is used to specify this physical interface when creating bonded interfaces, VLANs, and aliases.
7. Specify the DNS name associated with the host’s IP address. Satellite saves this name in Capsule Server associated with the selected domain (the "DNS A" field) and Capsule Server associated with the selected subnet (the "DNS PTR" field). A single host can therefore have several DNS entries.
8. Select a domain from the Domain list. To create and manage domains, navigate to Infrastructure > Domains.
9. Select a subnet from the Subnet list. To create and manage subnets, navigate to Infrastructure > Subnets.
10. Specify the IP address. Managed interfaces with an assigned DHCP Capsule Server require this setting for creating a DHCP lease. DHCP-enabled managed interfaces are automatically provided with a suggested IP address.
11. Select whether the interface is Managed. If the interface is managed, configuration is pulled from the associated Capsule Server during provisioning, and DNS and DHCP entries are created. If using Kickstart provisioning, a configuration file is automatically created for the interface.
12. Select whether this is the Primary interface for the host. The DNS name from the primary interface is used as the host portion of the FQDN.
13. Select whether this is the Provision interface for the host. TFTP boot takes place using the provisioning interface. For image-based provisioning, the script to complete the provisioning is executed through the provisioning interface.
14. Select whether to use the interface for Remote execution.
15. Leave the Virtual NIC checkbox clear.
16. Click OK to save the interface configuration.
17. Click Submit to apply the changes to the host.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click Edit next to the host you want to edit.
3. On the Interfaces tab, click Add Interface.
4. Keep the Interface option selected in the Type list.

5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 5.1, “Adding a physical interface”.

   Specify a MAC address for managed virtual interfaces so that the configuration files for provisioning are generated correctly. However, a MAC address is not required for virtual interfaces that are not managed.

   If creating a VLAN, specify ID in the form of eth1.10 in the Device Identifier field. If creating an alias, use ID in the form of eth1:10.

6. Select the Virtual NIC checkbox. Additional configuration options specific to virtual interfaces are appended to the form:

   • Tag: Optionally set a VLAN tag to trunk a network segment from the physical network through to the virtual interface. If you do not specify a tag, managed interfaces inherit the VLAN tag of the associated subnet. User-specified entries from this field are not applied to alias interfaces.
   • Attached to: Specify the identifier of the physical interface to which the virtual interface belongs, for example eth1. This setting is required.
7. Click OK to save the interface configuration.
8. Click Submit to apply the changes to the host.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Click Edit next to the host you want to edit.
3. On the Interfaces tab, click Add Interface.
4. Select Bond from the Type list. Additional type-specific configuration options are appended to the form.

5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 5.1, “Adding a physical interface”.

   Bonded interfaces use IDs in the form of bond0 in the Device Identifier field.

   A single MAC address is sufficient.

   If you are adding a secondary interface, select Managed. Otherwise, Satellite does not apply the configuration.

6. Specify the configuration options specific to bonded interfaces:

   • Mode: Select the bonding mode that defines a policy for fault tolerance and load balancing. See Section 5.4, “Bonding modes available in Satellite” for a brief description of each bonding mode.
   • Attached devices: Specify a comma-separated list of identifiers of attached devices. These can be physical interfaces or VLANs.
   • Bond options: Specify a space-separated list of configuration options, for example miimon=100. For more information on configuration options for bonded interfaces, see Configuring network bonding in Red Hat Enterprise Linux 8 Configuring and Managing Networking.
7. Click OK to save the interface configuration.
8. Click Submit to apply the changes to the host.

Procedure

1. Enable BMC power management on your Capsule:

   # satellite-installer \
   --foreman-proxy-bmc-default-provider=ipmitool \
   --foreman-proxy-bmc=true

2. In the Satellite web UI, navigate to Infrastructure > Subnets.
3. Select the subnet of your host.
4. On the Capsules tab, select your Capsule as BMC Capsule.
5. Click Submit.
6. Navigate to Hosts > All Hosts.
7. Click Edit next to the host you want to edit.
8. On the Interfaces tab, click Add Interface.
9. Select BMC from the Type list. Type-specific configuration options are appended to the form.
10. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 5.1, “Adding a physical interface”.

11. Specify the configuration options specific to BMC interfaces:

    • Username and Password: Specify any authentication credentials required by BMC.
    • Provider: Specify the BMC provider.
12. Click OK to save the interface configuration.
13. Click Submit to apply the changes to the host.

Procedure

1. In the Satellite web UI, navigate to Monitor > Jobs.
2. Click Run Job.
3. From the Job category list, select Commands.
4. From the Job template list, select Download and run a script.
5. Click Next.
6. Select hosts on which you want to execute the job.

7. In the url field, enter the following URL:

   https://satellite.example.com/unattended/public/foreman_ca_refresh

   Replace satellite.example.com with the FQDN of your Satellite Server.

   You can use HTTP when the CA certificate is expired.

8. Optional: Click Next and configure advanced fields and scheduling as you require.
9. Click Run on selected hosts.

Procedure

1. In the Satellite web UI, navigate to Monitor > Jobs.
2. Click Run Job.
3. From the Job category list, select Ansible Commands.
4. From the Job template list, select Download and execute a script.
5. Click Next.
6. Select hosts on which you want to execute the job.

7. In the url field, enter the following URL:

   https://satellite.example.com/unattended/public/foreman_ca_refresh

   Replace satellite.example.com with the FQDN of your Satellite Server.

   You can use HTTP when the CA certificate is expired.

8. Optional: Click Next and configure advanced fields and scheduling as you require.
9. Click Run on selected hosts.

Procedure

1. Download the certificate on your Satellite Server:

   # curl -o "satellite_ca_cert.crt" https://satellite.example.com/unattended/public/foreman_raw_ca

   Replace satellite.example.com with the FQDN of your Satellite Server.

2. Transfer the CA certificate to your host securely, for example by using scp.
3. Login to your host by using SSH.

4. Copy the certificate to the Subscription Manager configuration directory:

   # cp -u satellite_ca_cert.crt /etc/rhsm/ca/katello-server-ca.pem

5. Copy the certificate to the truststore:

   # cp satellite_ca_cert.crt /etc/pki/ca-trust/source/anchors

6. Update the truststore:

   # update-ca-trust

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts and select the host that you want to manage and monitor with the RHEL web console.
2. In the upper right of the host window, click the vertical ellipsis and select Web Console.

Procedure

1. In the Satellite web UI, navigate to Host > All Hosts.
2. Select any host for which you want to change the value.
3. On the Parameters tab, click on the edit button of host_registration_insights.
4. Set the value to False.

Procedure

1. Add the RedHatInsights.insights-client role to the hosts.

   For new hosts, see Section 2.1, “Creating a host in Red Hat Satellite”.

   For existing hosts, see Using Ansible Roles to Automate Repetitive Tasks on Clients in Managing configurations by using Ansible integration.

2. To run the RedHatInsights.insights-client role on your host, navigate to Hosts > All Hosts and click the name of the host that you want to use.
3. On the host details page, expand the Schedule a job dropdown menu.
4. Click Run Ansible roles.

Procedure

1. In the Satellite web UI, navigate to Configure > Inventory Upload.
2. Enable the Automatic Mismatch Deletion setting.

Procedure

1. In the Satellite web UI, navigate to Configure > Insights.

2. On the Red Hat Insights page, select the number of recommendations that you want to include in an Insights plan.

   You can only select the recommendations that have an associated playbook.

3. Click Remediate.
4. In the Remediation Summary window, you can select the Resolutions to apply. Use the Filter field to search for specific keywords.
5. Click Remediate.
6. In the Job Invocation page, do not change the contents of precompleted fields.
7. Optional. For more advanced configuration of the Remote Execution Job, click Show Advanced Fields.
8. Select the Type of query you require.
9. Select the Schedule you require.
10. Click Submit.

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select a host.
3. On the Host details page, click Recommendations.
4. On the Red Hat Insights page, select the number of recommendations you want to include in an Insights plan and proceed as before.

Procedure

1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates. For example, the Host – Installed Products template generates a report with installed product information along with other metrics, including system purpose attributes.
2. To the right of the report template that you want to use, click Generate.
3. Optional: To schedule a report, to the right of the Generate at field, click the icon to select the date and time you want to generate the report at.
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: Apply search query filters. To view all available results, do not populate the filter field with any values.
6. Click Submit. A CSV file that contains the report is downloaded. If you have selected the Send report via e-mail checkbox, the host monitoring report is sent to your e-mail address.

CLI procedure

1. List all available report templates:

   # hammer report-template list

2. Generate a report:

   # hammer report-template generate --id My_Template_ID

   This command waits until the report fully generates before completing. If you want to generate the report as a background task, you can use the hammer report-template schedule command.

   Note

   If you want to generate the Subscription - General report, you have to use the Days from Now option to specify the latest expiration time of general subscriptions.

   Show all subscriptions

   # hammer report-template generate \
   --inputs "Days from Now=no limit" \
   --name "Subscription - General Report"

   Show all subscriptions that are going to expire within 60 days

   # hammer report-template generate \
   --inputs "Days from Now=60" \
   --name "Subscription - General Report"

Procedure

1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates.
2. Click Create Template.
3. In the Name field, enter a unique name for your report template.
4. If you want the template to be available to all locations and organizations, select Default.
5. Create the template directly in the template editor or import a template from a text file by clicking Import. For more information about importing templates, see Section 11.5, “Importing report templates”.
6. Optional: In the Audit Comment field, you can add any useful information about this template.
7. Click the Input tab, and in the Name field, enter a name for the input that you can reference in the template in the following format: input('name'). Note that you must save the template before you can reference this input value in the template body.
8. Select whether the input value is mandatory. If the input value is mandatory, select the Required checkbox.
9. From the Value Type list, select the type of input value that the user must input.
10. Optional: If you want to use facts for template input, select the Advanced checkbox.
11. Optional: In the Options field, define the options that the user can select from. If this field remains undefined, the users receive a free-text field in which they can enter the value they want.
12. Optional: In the Default field, enter a value, for example, a host name, that you want to set as the default template input.
13. Optional: In the Description field, you can enter information that you want to display as inline help about the input when you generate the report.
14. Optional: Click the Type tab, and select whether this template is a snippet to be included in other templates.
15. Click the Location tab and add the locations where you want to use the template.
16. Click the Organizations tab and add the organizations where you want to use the template.
17. Click Submit to save your changes.

Procedure

1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates.
2. Locate the template that you want to export, and from the list in the Actions column, select Export.
3. Repeat this action for every report template that you want to download.

CLI procedure

1. To view the report templates available for export, enter the following command:

   # hammer report-template list

   Note the template ID of the template that you want to export in the output of this command.

2. To export a report template, enter the following command:

   # hammer report-template dump --id My_Template_ID > example_export.erb

Procedure

1. Use the following request to retrieve a list of available report templates:

   Example request:

   $ curl \
   --insecure \
   --user My_User_Name:My_Password \
   --request GET \
   --config https://satellite.example.com/api/report_templates \
   | json_reformat

   In this example, the json_reformat tool is used to format the JSON output.

   Example response:

   {
       "total": 6,
       "subtotal": 6,
       "page": 1,
       "per_page": 20,
       "search": null,
       "sort": {
           "by": null,
           "order": null
       },
       "results": [
           {
               "created_at": "2019-11-20 17:49:52 UTC",
               "updated_at": "2019-11-20 17:49:52 UTC",
               "name": "Applicable errata",
               "id": 112
           },
           {
               "created_at": "2019-11-20 17:49:52 UTC",
               "updated_at": "2019-11-20 17:49:52 UTC",
               "name": "Applied Errata",
               "id": 113
           },
           {
               "created_at": "2019-11-30 16:15:24 UTC",
               "updated_at": "2019-11-30 16:15:24 UTC",
               "name": "Hosts - complete list",
               "id": 158
           },
           {
               "created_at": "2019-11-20 17:49:52 UTC",
               "updated_at": "2019-11-20 17:49:52 UTC",
               "name": "Host statuses",
               "id": 114
           },
           {
               "created_at": "2019-11-20 17:49:52 UTC",
               "updated_at": "2019-11-20 17:49:52 UTC",
               "name": "Registered hosts",
               "id": 115
           },
           {
               "created_at": "2019-11-20 17:49:52 UTC",
               "updated_at": "2019-11-20 17:49:52 UTC",
               "name": "Subscriptions",
               "id": 116
           }
       ]
   }

2. Note the id of the template that you want to export, and use the following request to export the template:

   Example request:

   $ curl --insecure --output /tmp/_Example_Export_Template.erb_ \
   --user admin:password --request GET --config \
   https://satellite.example.com/api/report_templates/My_Template_ID/export

   Note that 158 is an example ID of the template to export.

   In this example, the exported template is redirected to host_complete_list.erb.

Procedure

1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates.
2. In the upper right of the Report Templates window, click Create Template.
3. On the upper right of the Editor tab, click the folder icon, and select the .erb file that you want to import.
4. Edit the template to suit your requirements.
5. Click Submit.

Procedure

1. Use the following example to format the template that you want to import to a .json file:

   # cat Example_Template.json
   {
       "name": "Example Template Name",
       "template": "
       Enter ERB Code Here
   "
   }

   Example JSON file with ERB template:

   {
       "name": "Hosts - complete list",
       "template": "
   <%#
   name: Hosts - complete list
   snippet: false
   template_inputs:
   - name: host
     required: false
     input_type: user
     advanced: false
     value_type: plain
     resource_type: Katello::ActivationKey
   model: ReportTemplate
   -%>
   <% load_hosts(search: input('host')).each_record do |host| -%>
   <%
         report_row(
             'Server FQDN': host.name
         )
   -%>
   <%  end -%>
   <%= report_render %>
   "
   }

2. Use the following request to import the template:

   $ curl \
   --insecure \
   --user My_User_Name:My_Password \
   --data @Example_Template.json \
   --header "Content-Type:application/json" \
   --request POST \
   --config https://satellite.example.com/api/report_templates/import

3. Use the following request to retrieve a list of report templates and validate that you can view the template in Satellite:

   $ curl \
   --insecure \
   --user My_User_Name:My_Password \
   --request GET \
   --config https://satellite.example.com/api/report_templates | json_reformat

Procedure

1. In the Satellite web UI, navigate to Monitor > Reports > Report Templates.
2. To the right of Host - All Installed Packages, click Generate.
3. Optional: Use the Hosts filter search field to search for and apply specific host filters.
4. Click Generate.
5. If the download does not start automatically, click Download.

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.

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.

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.

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.

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.

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.

1. Satellite finds the host’s interfaces that have the Remote execution checkbox selected.
2. Satellite finds the subnets of these interfaces.
3. Satellite finds remote execution Capsules assigned to these subnets.
4. From this set of Capsules, Satellite selects the Capsule that has the least number of running jobs. By doing this, Satellite ensures that the jobs load is balanced between remote execution Capsules.

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Job templates.
2. Click New Job Template.
3. Click the Template tab, and in the Name field, enter a unique name for your job template.
4. Select Default to make the template available for all organizations and locations.
5. Create the template directly in the template editor or upload it from a text file by clicking Import.
6. Optional: In the Audit Comment field, add information about the change.
7. Click the Job tab, and in the Job category field, enter your own category or select from the default categories listed in Default Job Template Categories in Managing hosts.
8. Optional: In the Description Format field, enter a description template. For example, Install package %{package_name}. You can also use %{template_name} and %{job_category} in your template.
9. From the Provider Type list, select SSH for shell scripts and Ansible for Ansible tasks or playbooks.
10. Optional: In the Timeout to kill field, enter a timeout value to terminate the job if it does not complete.
11. Optional: Click Add Input to define an input parameter. Parameters are requested when executing the job and do not have to be defined in the template. For examples, see the Help tab.
12. Optional: Click Foreign input set to include other templates in this job.
13. Optional: In the Effective user area, configure a user if the command cannot use the default remote_execution_effective_user setting.
14. Optional: If this template is a snippet to be included in other templates, click the Type tab and select Snippet.
15. Optional: If you use the Ansible provider, click the Ansible tab. Select Enable Ansible Callback to allow hosts to send facts, which are used to create configuration reports, back to Satellite after a job finishes.
16. Click the Location tab and add the locations where you want to use the template.
17. Click the Organizations tab and add the organizations where you want to use the template.
18. Click Submit to save your changes.

Procedure

1. Fetch the available Ansible Playbooks by using the following API request:

   $ curl \
   --header 'Content-Type: application/json' \
   --request GET \
   https://satellite.example.com/ansible/api/v2/ansible_playbooks/fetch?proxy_id=My_capsule_ID

2. Select the Ansible Playbook you want to import and note its name.

3. Import the Ansible Playbook by its name:

   $ curl \
   --data '{ "playbook_names": ["My_Playbook_Name"] }' \
   --header 'Content-Type: application/json' \
   --request PUT \
   https://satellite.example.com/ansible/api/v2/ansible_playbooks/sync?proxy_id=My_capsule_ID

   You get a notification in the Satellite web UI after the import completes.

Procedure

1. In the Satellite web UI, navigate to Administer > Settings.
2. Click Remote Execution.
3. Configure the Fallback to Any Capsule setting.

Procedure

1. In the Satellite web UI, navigate to Administer > Settings.
2. Click Remote Execution.
3. Configure the Enable Global Capsule setting.

Procedure

1. On your host, create a new directory:

   # mkdir /My_Remote_Working_Directory

2. Copy the SELinux context from the default /var/tmp directory:

   # chcon --reference=/var/tmp /My_Remote_Working_Directory

3. Configure your Satellite Server or Capsule Server to use the new directory:

   # satellite-installer \
   --foreman-proxy-plugin-remote-execution-script-remote-working-dir /My_Remote_Working_Directory

1. Create a new directory:

   # mkdir /My_Remote_Working_Directory

2. Access the yggdrasild service configuration:

   # systemctl edit yggdrasild

3. Specify the alternative directory by adding the following line to the configuration:

   Environment=FOREMAN_YGG_WORKER_WORKDIR=/My_Remote_Working_Directory

4. Restart the yggdrasild service:

   # systemctl restart yggdrasild

Procedure

1. Navigate to Administer > Settings.
2. Select the Remote Execution tab.
3. Click the value of the Effective User Method setting.
4. Select the new value.
5. Click Submit.

1. Section 13.15, “Distributing SSH keys for remote execution manually”.
2. Section 13.17, “Using the Satellite API to obtain SSH keys for remote execution”.
3. Section 13.18, “Configuring a Kickstart template to distribute SSH keys during provisioning”.
4. For new Satellite hosts, you can deploy SSH keys to Satellite hosts during registration using the global registration template. For more information, see Registering a Host to Red Hat Satellite Using the Global Registration Template in Managing hosts.

Procedure

1. On the target host, create the ~/.ssh directory to store the SSH key:

   # mkdir ~/.ssh

2. Download the SSH key from Capsule:

   # curl https://capsule.example.com:9090/ssh/pubkey >> ~/.ssh/authorized_keys

3. Configure permissions for the ~/.ssh directory:

   # chmod 700 ~/.ssh

4. Configure permissions for the authorized_keys file:

   # chmod 600 ~/.ssh/authorized_keys

Procedure

1. Find the ID of the foreman-proxy user:

   # id -u foreman-proxy

2. Modify the umask value so that new files have the permissions 600:

   # umask 077

3. Create the directory for the keytab:

   # mkdir -p "/var/kerberos/krb5/user/My_User_ID"

4. Create a keytab or copy an existing keytab to the directory:

   # cp My_Client.keytab /var/kerberos/krb5/user/My_User_ID/client.keytab

5. Change the directory owner to the foreman-proxy user:

   # chown -R foreman-proxy:foreman-proxy "/var/kerberos/krb5/user/My_User_ID"

6. Ensure that the keytab file is read-only:

   # chmod -wx "/var/kerberos/krb5/user/My_User_ID/client.keytab"

7. Restore the SELinux context:

   # restorecon -RvF /var/kerberos/krb5

Procedure

1. To install and enable Kerberos authentication for remote execution, enter the following command:

   # satellite-installer --foreman-proxy-plugin-remote-execution-script-ssh-kerberos-auth true

2. To edit the default user for remote execution, in the Satellite web UI, navigate to Administer > Settings and click the Remote Execution tab. In the SSH User row, edit the second column and add the user name for the Kerberos account.
3. Navigate to remote_execution_effective_user and edit the second column to add the user name for the Kerberos account.

Procedure

1. To clone a template, in the Actions column, select Clone.
2. Enter a unique name for the clone and click Submit to save the changes.

Procedure

1. In the Satellite web UI, navigate to Monitor > Jobs and click Run job.
2. Select the Job category and the Job template you want to use, then click Next.

3. Select hosts on which you want to run the job. If you do not select any hosts, the job will run on all hosts you can see in the current context.

   Note

   If you want to select a host group and all of its subgroups, it is not sufficient to select the host group as the job would only run on hosts directly in that group and not on hosts in subgroups. Instead, you must either select the host group and all of its subgroups or use this search query:

   hostgroup_fullname ~ "My_Host_Group*"

   Replace My_Host_Group with the name of the top-level host group.

4. If required, provide inputs for the job template. Different templates have different inputs and some templates do not have any inputs. After entering all the required inputs, click Next.
5. Optional: To configure advanced settings for the job, fill in the Advanced fields. To learn more about advanced settings, see Section 13.23, “Advanced settings in the job wizard”.
6. Click Next.

7. Schedule time for the job.

   • To execute the job immediately, keep the pre-selected Immediate execution.
   • To execute the job in future time, select Future execution.
   • To execute the job on regular basis, select Recurring execution.

8. Optional: If you selected future or recurring execution, select the Query type, otherwise click Next.

   • Static query means that job executes on the exact list of hosts that you provided.
   • Dynamic query means that the list of hosts is evaluated just before the job is executed. If you entered the list of hosts based on some filter, the results can be different from when you first used that filter.

   Click Next after you have selected the query type.

9. Optional: If you selected future or recurring execution, provide additional details:

   • For Future execution, enter the Starts at date and time. You also have the option to select the Starts before date and time. If the job cannot start before that time, it will be canceled.
   • For Recurring execution, select the start date and time, frequency, and the condition for ending the recurring job. You can choose the recurrence to never end, end at a certain time, or end after a given number of repetitions. You can also add Purpose - a special label for tracking the job. There can only be one active job with a given purpose at a time.

   Click Next after you have entered the required information.

10. Review job details. You have the option to return to any part of the job wizard and edit the information.
11. Click Submit to schedule the job for execution.

CLI procedure

1. Enter the following command on Satellite:

   # hammer settings set \
   --name=remote_execution_global_proxy \
   --value=false

2. Find the ID of the job template you want to use:

   # hammer job-template list

3. Show the template details to see parameters required by your template:

   # hammer job-template info --id My_Template_ID

4. Execute a remote job with custom parameters:

   # hammer job-invocation create \
   --inputs My_Key_1="My_Value_1",My_Key_2="My_Value_2",... \
   --job-template "My_Template_Name" \
   --search-query "My_Search_Query"

   Replace My_Search_Query with the filter expression that defines hosts, for example "name ~ My_Pattern".

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts and select the target host on which you want to execute a remote job.
2. On the Ansible tab, select Jobs.
3. Click Schedule recurring job.
4. Define the repetition frequency, start time, and date of the first run in the Create New Recurring Ansible Run window.
5. Click Submit.
6. Optional: View the scheduled Ansible job in host overview or by navigating to Ansible > Jobs.

Procedure

1. In the Satellite web UI, navigate to Configure > Host groups.
2. In the Actions column, select Configure Ansible Job for the host group you want to schedule an Ansible roles run for.
3. Click Schedule recurring job.
4. Define the repetition frequency, start time, and date of the first run in the Create New Recurring Ansible Run window.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Administer > Remote Execution Features.
2. Find each feature whose name contains by_search.
3. Change the job template for these features from Katello Script Default to Katello Ansible Default.
4. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts,
2. Select a host.
3. On the Content tab, click the Repository sets tab.
4. Click the vertical ellipsis to choose Override to disabled or Override to enabled to disable or enable repositories on hosts.

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select a host.
3. On the Content tab, click the Packages tab.
4. On the vertical ellipsis icon next to the upgrade button, click Install packages.
5. In the Install packages window, select the package or packages that you want to install on the host.
6. Click Install. The Satellite web UI shows a notification for the remote execution job.

API procedure

1. Create the "job_invocation" object and place rest of the body inside this object.
2. Create the "inputs" object with the "package" field of the string type specifying the packages you want to install. If you are specifying multiple packages, separate them with a whitespace.
3. Create a "feature" field of the string type with value "katello_package_install".
4. Create a "search_query" field of the string type and input a search query matching the hosts on which you want to install the packages.

5. Optional: If you want to install packages as a specific user, create an ssh object with the following fields of the string type:

   • "effective_user" with the name of the ssh user
   • "effective_user_password" with the password of the ssh user if this password is required

6. Optional: If you want to install packages at a later time, create the "scheduling" object. The object can contain one or both of the following fields of the string type with date, time, and a timezone in the ISO 8601 format:

   • "start_at"- sets the time to install the packages
   • "start_before" - sets the latest time to install the packages. If it is not possible to install the packages by this time, then this action is cancelled.

   If you omit time, it defaults to 00:00:00. If you omit timezone, it defaults to UTC.

7. Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.
8. Optional: If you want to install packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

9. Send a POST request with the created body to the /api/job_invocations endpoint of your Satellite Server and use a tool like Python to see a formatted response.

   Example API request:

   curl https://satellite.example.com/api/job_invocations \
   -H "content-type: application/json" \
   -X POST \
   -d @Path_To_My_API_Request_Body \
   -u My_Username:My_Password | python3 -m json.tool

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select a host.
3. On the Content tab, click the Packages tab.
4. Select Upgradable from the Status list.
5. In the Upgradable to column, select the package version that you want to upgrade to.
6. Select the packages you want to upgrade.
7. Click Upgrade. The Satellite web UI shows a notification for the remote execution job.

API procedure

1. Create the "job_invocation" object and place rest of the body inside this object.
2. Create the "inputs" object with the "package" field of the string type specifying the packages you want to update. If you are specifying multiple packages, separate them with a whitespace.
3. Create a "feature" field of the string type with value "katello_package_update".
4. Create a "search_query" field of the string type and input a search query matching the hosts on which you want to update the packages.

5. Optional: If you want to update packages as a specific user, create an ssh object with the following fields of the string type:

   • "effective_user" with the name of the ssh user
   • "effective_user_password" with the password of the ssh user if this password is required

6. Optional: If you want to update packages at a later time, create the "scheduling" object. The object can contain one or both of the following fields of the string type with date, time, and a timezone in the ISO 8601 format:

   • "start_at"- sets the time to update the packages
   • "start_before" - sets the latest time to update the packages. If it is not possible to update the packages by this time, then this action is cancelled.

   If you omit time, it defaults to 00:00:00. If you omit timezone, it defaults to UTC.

7. Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.
8. Optional: If you want to update packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

9. Send a POST request with the created body to the /api/job_invocations endpoint of your Satellite Server and use a tool like Python to see a formatted response.

   Example API request:

   curl https://satellite.example.com/api/job_invocations \
   -H "content-type: application/json" \
   -X POST \
   -d @Path_To_My_API_Request_Body \
   -u My_Username:My_Password | python3 -m json.tool

Procedure

1. In the Satellite web UI, navigate to Hosts > All Hosts.
2. Select a host.
3. On the Content tab, click the Packages tab.
4. Click the vertical ellipsis for the package you want to remove.
5. Select Remove. The Satellite web UI shows a notification for the remote execution job.

API procedure

1. Create the "job_invocation" object and place rest of the body inside this object.
2. Create the "inputs" object with the "package" field of the string type specifying the packages you want to remove. If you are specifying multiple packages, separate them with a whitespace.
3. Create a "feature" field of the string type with value "katello_package_remove".
4. Create a "search_query" field of the string type and input a search query matching the hosts on which you want to remove the packages.

5. Optional: If you want to remove packages as a specific user, create an ssh object with the following fields of the string type:

   • "effective_user" with the name of the ssh user
   • "effective_user_password" with the password of the ssh user if this password is required

6. Optional: If you want to remove packages at a later time, create the "scheduling" object. The object can contain one or both of the following fields of the string type with date, time, and a timezone in the ISO 8601 format:

   • "start_at"- sets the time to remove the packages
   • "start_before" - sets the latest time to remove the packages. If it is not possible to remove the packages by this time, then this action is cancelled.

   If you omit time, it defaults to 00:00:00. If you omit timezone, it defaults to UTC.

7. Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.
8. Optional: If you want to remove packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

9. Send a POST request with the created body to the /api/job_invocations endpoint of your Satellite Server and use a tool like Python to see a formatted response.

   Example API request:

   curl https://satellite.example.com/api/job_invocations \
   -H "content-type: application/json" \
   -X POST \
   -d @Path_To_My_API_Request_Body \
   -u My_Username:My_Password | python3 -m json.tool