Managing Hosts

Procedure

1. In the Satellite web UI, click 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 mange 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 check box to configure the interface during provisioning to use the Capsule provided DHCP and DNS services.
      • Primary — Select this check box to use the DNS name from this interface as the host portion of the FQDN.
      • Provision — Select this check box 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 RPMs by anaconda, Puppet setup in a %post script, will use the primary interface.

      • Virtual NIC — Select this check box 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. See Chapter 4, Adding Network Interfaces for details.
   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 Red Hat Enterprise Linux 8 host, you can set system purpose attributes. System purpose attributes define what subscriptions to attach automatically on host creation. In the Host Parameters area, enter the following parameter names with the corresponding values. For the list of values, see Configuring system purpose in the Performing a standard RHEL installation guide.

   • syspurpose_role
   • syspurpose_sla
   • syspurpose_usage
   • syspurpose_addons
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 > Content Hosts and click the name of the Red Hat Enterprise Linux 8 host that you want to edit.
2. In the System Purpose area, click the Edit or Remove icon for the system purpose attributes that you want to edit, add, or remove.
3. Click Save.
4. Click the Subscriptions tab and select Subscriptions.
5. Click Run Auto-Attach to attach subscriptions to your host automatically.
6. Refresh the page to verify that the subscriptions list contains the correct subscriptions.

For CLI Users

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 Configuring system purpose in the Performing a standard RHEL installation guide.

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

2. Verify the system purpose attributes for this host:

   # syspurpose show

3. Automatically attach subscriptions to this host:

   # subscription-manager attach --auto

4. Verify the system purpose status for this host:

   # subscription-manager status

Procedure

1. In the Satellite web UI, navigate to Hosts > Content Hosts and click the name of the host that contains the modules you want to change.
2. Click the Module Streams tab.
3. From the Available Module Streams list, locate the module that you want to change. You can use the Filter field to refine the list entries. You can also use the Filter Status list to search for modules with a specific status.
4. From the Actions list, select the change that you want to make to the module.
5. In the Job Invocation window, ensure that the job information is accurate. Change any details that you require, and then click Submit.

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 and change the owner:

   # mkdir /etc/puppetlabs/code/environments/example_environment
   # chown apache /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. Select the check box of the host you want to change.
3. From the Select Action list, select Change Group. A new option window opens.
4. From the Host Group list, select the group that you want for your host.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All hosts.
2. Select the check box of the host you want to change.
3. From the Select Action list, select Change Environment. A new option window opens.
4. From the Environment list, select the new environment for your host.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > All hosts.
2. Select the host.
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. Select the check box 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 check box 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 check box 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 check box 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 > 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 Red Hat Satellite permanently.

Disassociating A Virtual Machine from Satellite without Removing it from a Hypervisor

1. In the Satellite web UI, navigate to Hosts > All Hosts and select the check box to the left of the hosts to be disassociated.
2. From the Select Action list, select the Disassociate Hosts button.
3. Optionally, select the check box to keep the hosts for future action.
4. Click Submit.

1. Note the fully qualified domain name (FQDN) of the Satellite Server or Capsule Server, for example server.example.com.

2. Log in to the host as the root user and download the katello-ca-consumer-latest.noarch.rpm package from Satellite Server or Capsule Server to which the host is to be registered. The consumer RPM configures the host to download content from the content source that is specified in Red Hat Satellite.

   # curl --insecure --output katello-ca-consumer-latest.noarch.rpm https://satellite.example.com/pub/katello-ca-consumer-latest.noarch.rpm

3. Install the katello-ca-consumer-latest.noarch.rpm package:

   # yum localinstall katello-ca-consumer-latest.noarch.rpm

   Note

   The RPM package is not signed. If required, you can add the --nosignature option to install the package. The katello-ca-consumer-hostname-1.0-1.noarch.rpm package is an additional katello-ca-consumer RPM that contains the server’s host name. The katello-ca-consumer-latest.noarch.rpm package always reflects the most recent version. Both serve the same purpose.

4. Clear any old host data related to Red Hat Subscription Manager (RHSM):

   # subscription-manager clean

5. Register the host using RHSM:

   # subscription-manager register --org=your_org_name \
   --activationkey=your_activation_key

   Example 3.1. Command Output after Registration:

   # subscription-manager register --org=MyOrg --activationkey=TestKey-1
   The system has been registered with id: 62edc0f8-855b-4184-b1b8-72a9dc793b96

Procedure

1. Log in to the Atomic Host as the root user.

2. Retrieve katello-rhsm-consumer from Satellite Server:

   # wget http://satellite.example.com/pub/katello-rhsm-consumer

3. Change the mode of katello-rhsm-consumer to make it executable:

   # chmod +x katello-rhsm-consumer

4. Run katello-rhsm-consumer:

   # ./katello-rhsm-consumer

   Register with Red Hat Subscription Manager:

   # subscription-manager register

1. Manually create a directory and change the owner:

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

2. Navigate to Configure > Environments and click Import environment from. The button name includes the FQDN of the internal or external Capsule.
3. 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. See Section 3.3.2, “Advanced Bootstrap Script Configuration” for advanced use cases.

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

     # /usr/libexec/platform-python bootstrap.py \
     --login=admin \
     --server satellite.example.com \
     --location="Example Location" \
     --organization="Example Organization" \
     --hostgroup="Example Host Group" \
     --activationkey=activation_key

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

     # ./bootstrap.py --login=admin \
     --server satellite.example.com \
     --location="Example Location" \
     --organization="Example Organization" \
     --hostgroup="Example Host Group" \
     --activationkey=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

1. Install the katello-agent package:

   # yum install katello-agent

2. Start the goferd service :

   # systemctl start goferd

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. In the Properties tab, examine the Properties table and find the Traces item. If you cannot find a Traces item in the Properties table, then Tracer is not installed.
5. Navigate to Hosts > Content Hosts, then click the required host name.
6. Click the Traces tab to view Traces.

Procedure

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

2. Install the Puppet agent package:

   # yum install puppet-agent

3. Configure the Puppet agent to start on boot:

   • On Red Hat Enterprise Linux 6:

     # chkconfig puppet on

   • On Red Hat Enterprise Linux 7:

     # systemctl enable puppet

4. Append the following server and environment settings to the /etc/puppetlabs/puppet/puppet.conf file. Set the environment parameter to the name of the Puppet environment to which the host belongs:

   environment = My_Example_Org_Library
   server = satellite.example.com
   ca_server = satellite.example.com

5. Run the Puppet agent on the host:

   # puppet agent -t

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

9. Enter the puppet agent command again:

   # puppet agent -t

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 the Capsule Server associated with the selected domain (the "DNS A" field) and the 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 check box 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 4.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 check box. 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 4.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.

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 Table 4.1, “Bonding Modes Available in Red Hat 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. See the Red Hat Enterprise Linux 7 Networking Guide for details of the configuration options you can specify for the bonded interface.
7. Click OK to save the interface configuration.
8. Click Submit to apply the changes to the host.

Procedure

1. Enable BMC on the Capsule server if it is not already enabled:

   1. Configure BMC power management on the Capsule Server by running the satellite-installer script with the following options:

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

   2. In the Satellite web UI, navigate to Infrastructure > Capsules.
   3. From the list in the Actions column, click Refresh. The list in the Features column should now include BMC.
2. In the Satellite web UI, navigate to Hosts > All hosts.
3. Click Edit next to the host you want to edit.
4. On the Interfaces tab, click Add Interface.
5. Select BMC from the Type list. Type-specific configuration options are appended to the form.
6. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 4.1, “Adding a Physical Interface”.

7. Specify the configuration options specific to BMC interfaces:

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

Procedure

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

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 Satellite Hosts in Configuring Satellite to use Ansible.

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. Click the Run Ansible roles button.

1. In the Satellite web UI, navigate to Insights > Inventory, and select the hosts that you want to include in an Insights plan.
2. From the Actions list, select Create a new Plan/Playbook.
3. From the Plan/Playbook Builder window, select Create new plan and enter a name for the plan.
4. Select whether you want the rule to apply to a specific system, group, or all systems.
5. Select one or more rules that you want to add to the plan. Use the Filter field to search for specific keywords.
6. Click Save.
7. In the Planner window, select Run Playbook.

Procedure

1. In the Satellite web UI, navigate to Monitor > Report Templates.
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 check box, 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 check box, the host monitoring report is sent to your e-mail address.

1. List all available report templates:

   # hammer report-template list

2. Generate a report:

   # hammer report-template generate --id 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.

Procedure

1. In the Satellite web UI, navigate to Monitor > Report Templates, and click Create Template.
2. In the Name field, enter a unique name for your report template.
3. If you want the template to be available to all locations and organizations, select Default.
4. 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 8.5, “Importing Report Templates”.
5. Optional: In the Audit Comment field, you can add any useful information about this template.
6. 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.
7. Select whether the input value is mandatory. If the input value is mandatory, select the Required check box.
8. From the Value Type list, select the type of input value that the user must input.
9. Optional: If you want to use facts for template input, select the Advanced check box.
10. 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.
11. Optional: In the Default field, enter a value, for example, a host name, that you want to set as the default template input.
12. 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.
13. Optional: Click the Type tab, and select whether this template is a snippet to be included in other templates.
14. Click the Location tab and add the locations where you want to use the template.
15. Click the Organizations tab and add the organizations where you want to use the template.
16. Click Submit to save your changes.

Procedure

1. In the Satellite web UI, navigate to Monitor > 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.

For CLI Users

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 template_ID > example_export.erb

Procedure

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

   Example request:

   $ curl --insecure --user admin:redhat \
   --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/158/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 > Report Templates, and in the upper right of the Report Templates window, click Create Template.
2. On the upper right of the Editor tab, click the folder icon, and select the .erb file that you want to import.
3. Edit the template to suit your requirements, and 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 FQND': host.name
         )
   -%>
   <%  end -%>
   <%= report_render %>
   "
   }

2. Use the following request to import the template:

   $ curl --insecure --user admin:redhat \
   --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 admin:redhat \
    --request GET --config https://satellite.example.com/api/report_templates | json_reformat

Procedure

1. In the Satellite web UI, navigate to Monitor > Report Templates, and click Create Template.

2. Optional: In the Editor field, use the <%# > tags to add a comment with information that might be useful for later reference. For example:

   <%#
   name: Entitlements
   snippet: false
   model: ReportTemplate
   require:
   - plugin: katello
     version: 3.14.0
   -%>

3. Add a line with the load_hosts() macro and populate the macro with the following method and variables:

   <%- load_hosts(includes: [:lifecycle_environment, :operatingsystem, :architecture, :content_view, :organization, :reported_data, :subscription_facet, :pools => [:subscription]]).each_record do |host| -%>

   To view a list of variables you can use, click the Help tab and in the Safe mode methods and variables table, find the Host::Managed row.

4. Add a line with the host.pools variable with the each method, for example:

   <%- host.pools.each do |pool| -%>

5. Add a line with the report_row() method to create a report and add the variables that you want to target as part of the report:

   <%-     report_row(
             'Name': host.name,
             'Organization': host.organization,
             'Lifecycle Environment': host.lifecycle_environment,
             'Content View': host.content_view,
             'Host Collections': host.host_collections,
             'Virtual': host.virtual,
             'Guest of Host': host.hypervisor_host,
             'OS': host.operatingsystem,
             'Arch': host.architecture,
             'Sockets': host.sockets,
             'RAM': host.ram,
             'Cores': host.cores,
             'SLA': host_sla(host),
             'Products': host_products(host),
             'Subscription Name': sub_name(pool),
             'Subscription Type': pool.type,
             'Subscription Quantity': pool.quantity,
             'Subscription SKU': sub_sku(pool),
             'Subscription Contract': pool.contract_number,
             'Subscription Account': pool.account_number,
             'Subscription Start': pool.start_date,
             'Subscription End': pool.end_date,
             'Subscription Guest': registered_through(host)
             ) -%>

6. Add end statements to the template:

   <%-   end -%>
   <%- end -%>

7. To generate a report, you must add the <%= report_render -%> macro:

   <%= report_render -%>

8. Click Submit to save the template.

To Create a Host Collection:

1. Click 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.

To Clone a Host Collection:

1. Click 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.

To Remove a Host Collection:

1. Click Hosts > Host Collections.
2. Choose the host collection to be removed.

3. Click Remove. An alert box appears:

   Are you sure you want to remove host collection Host Collection Name?

4. Click Remove.

To Add Hosts to a Host Collection:

1. Click Hosts > Host Collections.
2. Click 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.

To Remove Hosts from a Host Collection:

1. Click 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.

To Remove Content from a Host Collection:

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 the Remove button 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.

To Change the Life Cycle Environment or Content View of a Host Collection:

1. Click Hosts > Host Collection.
2. Selection the host collection where the life cycle environment or Content View should be changed.
3. On the Collection Actions tab, click Change assigned Life Cycle Environment or Content View.
4. Select the life cycle 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.

1. Satellite finds the host’s interfaces that have the Remote execution check box 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.

5. If Satellite does not find a remote execution Capsule at this stage, and if the Fallback to Any Capsule setting is enabled, Satellite adds another set of Capsules to select the remote execution Capsule from. Satellite selects the most lightly loaded Capsule from the following types of Capsules that are assigned to the host:

   • DHCP, DNS and TFTP Capsules assigned to the host’s subnets
   • DNS Capsule assigned to the host’s domain
   • Realm Capsule assigned to the host’s realm
   • Puppet Master Capsule
   • Puppet CA Capsule
   • OpenSCAP Capsule
6. If Satellite does not find a remote execution Capsule at this stage, and if the Enable Global Capsule setting is enabled, Satellite selects the most lightly loaded remote execution Capsule from the set of all Capsules in the host’s organization and location to execute a remote job.

1. Navigate to Hosts > 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 Section B.2, “Default Job Template Categories”.
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. 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 Administer > Settings.
2. Click RemoteExecution.
3. Configure the Fallback to Any Capsule setting.

Procedure

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

1. Create a new directory, for example new_place:

   # mkdir /remote_working_dir

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

   # chcon --reference=/var /remote_working_dir

3. Edit the remote_working_dir setting in the /etc/foreman-proxy/settings.d/remote_execution_ssh.yml file to point to the required directory, for example:

   :remote_working_dir: /remote_working_dir

1. Section 10.9, “Distributing SSH Keys for Remote Execution Manually”.
2. Section 10.10, “Using the Satellite API to Obtain SSH Keys for Remote Execution”.
3. Section 10.11, “Configuring a Kickstart Template to Distribute SSH Keys during Provisioning”.

Procedure

1. Enter the following command on Capsule. Repeat for each target host you want to manage:

   # ssh-copy-id -i ~foreman-proxy/.ssh/id_rsa_foreman_proxy.pub root@target.example.com

2. To confirm that the key was successfully copied to the target host, enter the following command on Capsule:

   # ssh -i ~foreman-proxy/.ssh/id_rsa_foreman_proxy root@target.example.com

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

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/USER_ID"

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

   # cp your_client.keytab /var/kerberos/krb5/user/USER_ID/client.keytab

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

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

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

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

7. Restore the SELinux context:

   # restorecon -RvF /var/kerberos/krb5

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

   # satellite-installer --scenario satellite \
    --foreman-proxy-plugin-remote-execution-ssh-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 RemoteExecution 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.

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. Navigate to Hosts > All Hosts and select the target hosts on which you want to execute a remote job. You can use the search field to filter the host list.
2. From the Select Action list, select Schedule Remote Job.
3. On the Job invocation page, define the main job settings:
4. Select the Job category and the Job template you want to use.
5. Optional: Select a stored search string in the Bookmark list to specify the target hosts.
6. Optional: Further limit the targeted hosts by entering a Search query. The Resolves to line displays the number of hosts affected by your query. Use the refresh button to recalculate the number after changing the query. The preview icon lists the targeted hosts.
7. The remaining settings depend on the selected job template. See Section 10.4, “Creating a Job Template:” for information on adding custom parameters to a template.

8. Optional: To configure advanced settings for the job, click Display advanced fields. Some of the advanced settings depend on the job template, the following settings are general:

   • Effective user defines the user for executing the job, by default it is the SSH user.
   • Concurrency level defines the maximum number of jobs executed at once, which can prevent overload of systems' resources in a case of executing the job on a large number of hosts.
   • Timeout to kill defines time interval in seconds after which the job should be killed, if it is not finished already. A task which could not be started during the defined interval, for example, if the previous task took too long to finish, is canceled.
   • Type of query defines when the search query is evaluated. This helps to keep the query up to date for scheduled tasks.

   • Execution ordering determines the order in which the job is executed on hosts: alphabetical or randomized.

     Concurrency level and Timeout to kill settings enable you to tailor job execution to fit your infrastructure hardware and needs.

9. To run the job immediately, ensure that Schedule is set to Execute now. You can also define a one-time future job, or set up a recurring job. For recurring tasks, you can define start and end dates, number and frequency of runs. You can also use cron syntax to define repetition. For more information about cron, see the Automating System Tasks section of the Red Hat Enterprise Linux 7 System Administrator’s Guide.
10. Click Submit. This displays the Job Overview page, and when the job completes, also displays the status of the job.

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

   # hammer job-template list

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

   # hammer job-template info --id template_ID

3. Execute a remote job with custom parameters:

   # hammer job-invocation create \
   --job-template "template_name" \
   --inputs key1="value",key2="value",... \
   --search-query "query"

   Replace query with the filter expression that defines hosts, for example "name ~ rex01". For more information about executing remote commands with hammer, enter hammer job-template --help and hammer job-invocation --help.

Procedure

1. Navigate to the Job page. This page is automatically displayed if you triggered the job with the Execute now setting. To monitor scheduled jobs, navigate to Monitor > Jobs and select the job run you wish to inspect.
2. On the Job page, click the Hosts tab. This displays the list of hosts on which the job is running.
3. In the Host column, click the name of the host that you want to inspect. This displays the Detail of Commands page where you can monitor the job execution in real time.
4. Click Back to Job at any time to return to the Job Details page.

1. Find the ID of a job:

   # hammer job-invocation list

2. Monitor the job output:

   # hammer job-invocation output \
   --id job_ID \
   --host host_name

3. Optional: to cancel a job, enter the following command:

   # hammer job-invocation cancel \
   --id job_ID

1. To enable the plug-in on your Satellite Server, enter the following command:

   # satellite-installer --enable-foreman-plugin-templates

2. To verify that the plug-in is installed correctly, ensure Administer > Settings includes the TemplateSync menu.

1. Disable the plug-in using the Satellite installer:

   # satellite-installer --no-enable-foreman-plugin-templates

2. Clean custom data of the plug-in. The command does not affect any templates that you created.

   # foreman-rake templates:cleanup

3. Uninstall the plug-in:

   # satellite-maintain packages remove foreman-plugin-templates