Host Configuration Guide

Procedure 3.3. To Create a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click New Filter.
3. In the Name field, specify the name of the new filter and choose a content type from the Content Type drop-down menu. Choose whether the filter includes or excludes the selected content type by selecting the Type drop-down menu. Optionally, insert a description in the Description field.
4. Click Save to save your new filter.

Procedure 3.4. To Add Content to a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click the name of the filter you want to edit. Depending on the type of filter selected, perform the following actions:
   1. If the filter is made for packages, specify a package name on the Packages subtab, and select a Detail value from the drop-down menu. Click Add to add the package to the filter.
   2. If the filter is made for package groups, click the Add subtab, and choose the desired package group. Click Add Package Group.
   3. If the filter is made for errata, click the Add subtab. Select the errata type (Security, Enhancement, or Bugfix), and specify a start date and end date. Click Add Errata.
   4. If the filter is made for errata - date and type, on the Erratum Date Range subtab, select the errata type (Security, Enhancement, or Bugfix) and specify a start date and end date. Click Save.
3. On the Affected Repositories subtab, choose whether the filter will affect all or a subset of repositories. If you choose a subset of repositories, select the desired repositories and click Update Repositories.
4. Click Publish New Version. Insert a comment if desired, then click Save.

Procedure 3.5. To Remove Content from a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and click the name of the filter you want to edit. Depending on the type of filter selected, perform the following actions:
   1. If the filter is made for packages, click the Packages subtab and select the Package Name check box next to the package to be removed. Click Remove Packages to remove the package from the filter.
   2. If the filter is made for package groups, click the List/Remove subtab and select the Name check box next to the package group to be removed. Click Remove Package Group to remove the package group from the filter.
   3. If the filter is made for errata, click the List/Remove subtab select the Errata ID check box next to the errata to be removed. Click Remove Errata to remove the errata from the filter.
   4. If the filter is made for errata - date and type, on the Erratum Date Range subtab, check the errata type (Security, Enhancement, or Bugfix). Specify the start date and end date. Click Save.
3. On the Affected Repositories subtab, choose whether the filter will affect all or a subset of repositories. If you choose a subset of repositories, select the desired repositories and click Update Repositories.
4. Click Publish New Version. Insert a comment if desired, and click Save.

Procedure 3.6. To Remove a Filter:

1. Navigate to Content → Content Views and select the Content View you want to filter.
2. Click Yum Content → Filters and select the check box next to the name of the package filter you want to remove.
3. Click Remove Filters.

Procedure 5.1. Installing OpenSCAP Packages

1. On the Satellite Server, install the OpenSCAP plug-in and content.

   1. # satellite-installer --enable-foreman-plugin-openscap

      Successful installation is indicated by a progress indicator, and the word Success!. The OpenSCAP plugin adds to the Satellite web UI a Compliance section, under the Hosts menu, containing the following pages:

      • Policies
      • SCAP Contents
      • Reports

   2. # yum install puppet-foreman_scap_client

2. On all external Capsule Servers, install the OpenSCAP plug-in and content.

   Note

   If OpenSCAP functionality is to be enabled on a Capsule Server, Puppet must already have been enabled on that server.

   # satellite-installer --enable-foreman-proxy-plugin-openscap

   Successful installation is indicated by a progress indicator, and the word Success!. This provides the Puppet classes required to set up hosts to perform OpenSCAP scans and creates the Cron jobs for automated compliance scanning.
3. On external Capsule Servers with the Puppet master role, install the OpenSCAP client.

   # yum install puppet-foreman_scap_client

   To identify the relevant external Capsule Servers, open the Satellite web UI, navigate to Infrastructure → Capsules and identify those external Capsule Servers with Puppet listed in the Features column.

Procedure 5.2. Load the Default OpenSCAP Content

• Load the OpenSCAP content on the Satellite Server.

  # foreman-rake foreman_openscap:bulk_upload:default

Procedure 5.3. Import OpenSCAP Puppet Modules

1. OpenSCAP requires a Puppet environment, but by default they are only created for Content Views which contain Puppet modules. To list available Puppet environments, open the Satellite web UI and navigate to Configure → Environments.
   If there are no Puppet environments, open a CLI session on the Satellite Server and create a directory for the production Puppet environment.

   # mkdir -p /etc/puppet/environments/production/modules

2. Import the OpenSCAP content into selected Puppet environments. Each host which is to be audited with OpenSCAP must be associated with a Puppet environment.
   1. In the Satellite web UI, select from the context menu Any Organization and Any Location.
   2. Navigate to Configure → Environments.
   3. Click Import, then Import from satellite.example.com.
   4. For each Puppet environment associated with hosts to be audited using OpenSCAP, select the check box, then click Update. If no other Puppet environment exists, select the production environment.
      The foreman_scap_client Puppet module, amongst others, will be added to the selected environments.
   5. Verify that the foreman_scap_client Puppet module has been added.
      Navigate to Configure → Environments, then click Classes in the Puppet environment's row. The procedure has been successful if the foreman_scap_client Puppet class is listed.

Procedure 5.4. Upload Extra SCAP Content

1. Log in to the Satellite web UI.
2. Navigate to Hosts → SCAP contents and click Upload New SCAP Content.
3. Enter a title in the Title text box. For example: RHEL 7.2 SCAP Content.
4. Click Choose file, navigate to the location containing the SCAP content file and select Open.
5. Click Submit.

Procedure 5.5. To Create a Policy:

1. In the Satellite web UI, navigate to Hosts → Policies, click New Policy and follow the wizard’s steps.
2. Enter a name for this policy, a description (optional), then click Next.
3. Select the SCAP Content and XCCDF Profile to be applied, then click Next.
4. Specify the scheduled time when the policy is to be applied, then click Next.
   Select Weekly, Monthly, or Custom from the Period drop-down list.
   • If you select Weekly, also select the desired day of the week from the Weekday drop-down list.
   • If you select Monthly, also specify the desired day of the month in the Day of month field.
   • If you select Custom, enter a valid Cron expression in the Cron line field.
   The Custom option allows for greater flexibility in the policy's schedule than either the Weekly or Monthly options.
5. Select the locations to which the policy is to be applied, then click Next.
6. Select the organizations to which the policy is to be applied, then click Next.
7. Select the host groups to which the policy is to be applied, then click Next.
8. Click Submit.

Procedure 5.6. To View a Policy:

1. In the Satellite web UI, navigate to Hosts → Policies.
2. Click Show Guide.

Procedure 5.7. To Edit a Policy:

1. In the Satellite web UI, navigate to Hosts → Policies.
2. From the drop-down list to the right of the policy's name, select Edit.
3. Edit the necessary attributes.
4. Click Submit.

Procedure 5.8.  To Bookmark a Search:

1. Apply your search criteria.
2. From the Search list select Bookmark this search.
3. Complete the Name field.
   If you want the bookmark available to other users of this Satellite instance, select the Public check box.
4. Click Submit.

Procedure 6.3. To Create a Container:

1. Navigate to Containers → New Container. Alternatively, navigate to Containers → All Containers and click New container.
2. In the Preliminary stage of container creation, configure the following settings:
   • On the Compute resource tab, select the compute resource from the Deployed on drop-down menu. For more information on compute resources, see Section 9.3.4, “Compute Resources”.
   • On the Locations tab, select the locations where the new container will be available.
   • On the Organizations tab, select the organizations where the new container will be available.
   Click Next to proceed.
3. In the Image stage of container creation, import an image that will act as a base for your container. This can be a platform image, or a previously created layered image. Select from one of the following options:
   • Select the Content View tab to import the image from a life cycle environment. Specify the life cycle environment, content view, repository, tag, and Capsule Server.
   • Select the Docker hub tab to import the image from the Docker Hub registry. After you type the image name to the Search field, Satellite automatically searches the compute resource. Click the looking glass icon to search the Docker Hub. Select the image from the list of search results and pick a tag from the drop-down list.
   • Select the External registry tab to import the image from an existing registry. Select the registry from the drop-down menu, and search it by the image name. Satellite populates the Tag field with tags available for the selected image name. For more information, see Section 6.3, “Importing External Registries”.
   Click Next to proceed.
4. In the Configuration stage of container creation, set the following parameters:
   • Provide the container name.
   • Specify a command to run inside the container.
   • Specify an entrypoint, which is a command that is executed automatically as soon as the container starts. The default entrypoint is /bin/sh -c.
   • Assign CPUs to the container. For example, 0-2,16 represents CPUs 0, 1, 2, and 16.
   • Define the relative share of CPU time for the container.
   • Specify a memory limit for the container. For example, 512m limits the container memory usage to 512 MB.
   Click Next to proceed.
5. In the final stage of container creation named Environment, select if you want to allocate a pseudo-tty, attach STDIN, STDOUT, and STDERR to the container. Click Add environment variable to create a custom environment variable for the container. Select the Run? check box to start the container automatically after it is created.
6. Click Submit to create the container.

Procedure 6.4. To Investigate a Container:

1. Navigate to Containers → All Containers.
2. On the Containers page, every Docker compute resource has a dedicated tab. Each of these tabs contains the table of available containers together with selected parameters of each container. Select the tab of the compute resource you want to inspect.
3. To view the container metadata, click the name of the container you want to inspect. Satellite displays the table of container properties.
4. On the Processes tab, you can view processes that are currently running in the container. Click on the process name to view the metadata of the process.
5. If the container is running, you can view its standard output in the Logs tab. If you selected the allocate a pseudo-tty check box when creating a container, the console is interactive. Otherwise, it displays the initial standard output produced when the container started.

Procedure 6.5. To Start or Stop a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click Power On next to the container you want to start. After starting the container, the button changes to Power Off, which allows for stopping the container. These actions are equivalent to the docker start and docker stop commands.

Procedure 6.6. To Commit a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click the name of the container you want to commit.
3. Click Commit. Satellite prompts you to:
   • Specify a repository name. This can be a single name or combined with the user name, for example user/my-rhel-image.
   • Assign a tag to the image.
   • Provide your contact information.
   • Provide an informative comment about the image.
4. Click Submit.

Procedure 6.7. To Remove a Container:

1. Navigate to Containers → All Containers to view the list of available containers.
2. Click the name of the container you want to delete.
3. Click Delete.
4. In the alert box, click OK to remove the container.

Procedure 6.8. To Create a Docker Repository:

1. Navigate to Content → Products. Click New Product, specify the product name and click Save.
2. Select the product you created in the previous step and navigate to the Repositories tab. Click Create Repository.
3. Specify the repository name and select docker from the Type drop-down menu. This unlocks additional fields where you specify the URL of the content source you want to synchronize in this registry. Specify which repository you want to pull from the content source in the Upstream Repository Name field.

   Note

   In the previous version of Red Hat Satellite it was possible to upload locally stored container images to the repository. With Red Hat Satellite 6.2, this is no longer possible.
4. Click Save to create the repository. First the URL and repository name is validated, then the repository is created.

Procedure 7.2. To Add a Subscription to an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key name you want to edit.
3. On the Subscriptions tab, select the Add subtab.
4. From the list of available subscriptions, select the subscriptions you want to add.
5. Click Add Selected.

Procedure 7.3. To Remove Subscriptions from an Activation Key:

1. Click Content → Activation keys.
2. A list of activation keys is displayed. Click the activation key you want to remove subscriptions from.
3. Click the Subscriptions tab.
4. Under the List/Remove subtab, a list of attached subscriptions is displayed. Select the subscriptions to be removed.
5. Click Remove Selected.

Procedure 7.4. To Enable or Disable Auto-Attach on an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key name that you want to edit.
3. Click the Subscriptions tab.
4. Click the edit icon next to Auto-Attach.
5. Select or deselect the check box to enable or disable auto-attach.
6. Click Save.

Procedure 7.5. To Set the Service Level on an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key name you want to edit.
3. Click the Details tab.
4. Click the edit icon next to Service Level.
5. Select the required service level from the drop-down list. The drop-down list only contains service levels available to the activation key.
6. Click Save.

Procedure 7.6. To Add Host Collections to an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key that you want to add a host collection to.
3. On the Host Collections tab click the Add subtab to display the list of available host collections.
4. Select the host collections you want to add, and then click Add Selected.

Procedure 7.7. To Remove Host Collections from the Activation Key:

1. Click Content → Activation keys.
2. A list of activation keys is displayed. Click the activation key you want to remove host collections from.
3. Click the Host Collections tab.
4. Under List/Remove subtab, a list of host collections attached to the activation key is displayed. Select the check box of the host collections you want to remove.
5. Click Remove Selected to remove host collections from the activation key.

Procedure 7.8. To Edit Product Content on an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key name that you want to edit.
3. Click the Product Content tab to view the products and repositories associated with the activation key through subscriptions.
4. Click the edit icon next to the repository you want to edit.
5. From the drop-down menu, select if the repository will be enabled or disabled. Click Save to apply the change.

Procedure 7.9. To Set a Life Cycle Environment and a Content View for an Activation Key:

1. Click Content → Activation keys.
2. Click the activation key name that you want to edit.
3. Click the check box next to the environment you want to associate with the activation key. Select a content view from the drop-down menu.
4. Click Save.

Procedure 9.2. To Create a Global Simple Parameter:

1. Click Configure → Global Parameters.
2. Click New Parameter.
3. Type a Name for the parameter's key.
4. Enter a Value for the parameter.
5. Optionally select if you want the value to be hidden in the web UI.
6. Click Submit.

Procedure 9.3. To Configure Smart Variables:

1. Click Configure → Puppet Classes.
2. Select a class from the list.
3. Click the Smart Variables tab. This displays a new screen. The left section contains a list of possible parameters the class supports. The right section contains the configuration options for the parameter selected. Click the Add Variable to add a new parameter. Otherwise, select a parameter from the left-hand list.
4. Type a name for the parameter in the Key field.
5. Edit the Description text box to add any plain text notes.
6. Select the Key type of data to pass. This is most commonly a string, but other data types are supported.
7. Enter a Default Value for the parameter to be sent to the Puppet Master if no host match occurs.
8. Optionally select Hidden value if the field contains data you do not want to be displayed while you are working.
9. Use the Optional Input Validator section to restrict the allowed values for the parameter. Choose a Validator type (either a list of comma separated values or a regular expression, regexp) and input the allowed values or regular expression code in the Validator rule field.
10. The Prioritize attribute order section provides options for overriding values for specific hosts based upon conditional arguments. The attribute type and its value is known as a matcher.
    1. Set the Order of precedence in which the host attributes or Facts are to be evaluated against the matchers by arranging the entries in the list. You can add to the default list. To create a logical AND condition between matchers, arrange them on one line as a comma separated list.
    2. Click Add Matcher to add a conditional argument. The attributes to match against should correspond to the entries in the Order list. If no matcher is configured then only the default value can be used for the override feature.
       For example, if the desired value of the parameter to be supplied to the Puppet Master is test for any host with a fully qualified domain name of server1.example.com, then specify the matcher as fqdn=server1.example.com and the Value as test.
       The precedence for matching is as follows:

       1. If the matcher is a host attribute, use that.
       2. If there are no attributes with that name, look for a matching host parameter (which is inherited according to the parameter hierarchy).
       3. If there is still no match, check the host Facts.

       It is recommend to use an attribute that is present in Facter and cannot be confused with a host attribute. Host attributes can be either host parameters or associations to the host, such as host group, domain, and organization. The matcher must only be something the host has one of, for example config group cannot be used because the host can have many config groups but a host only has one location so location is a valid matcher.
       Dynamic data is possible by using parameters and Puppet Facts in the Value field in Embedded Ruby (ERB) template syntax. For example, to use a Puppet Fact as part of the value:

       <%= @host.facts['network_eth0'] %>

       To list available Puppet Facts navigate to Monitor → Facts.
11. Click Submit to save your changes.

Procedure 9.4. To Import Parameterized Classes:

1. In the Satellite web UI, select from the context menu Any Organization and Any Location.
2. Click Configure → Puppet Classes.
3. Click Import from Host Name to import parameterized classes from your Puppet Master.
4. The Puppet Classes page displays with the new classes listed.

Procedure 9.5. To Configure Smart Class Parameters:

1. Click Configure → Puppet Classes.
2. Select a class from the list that has parameters as indicated in the Parameters column.
3. Click the Smart Class Parameter tab. This displays a new screen. The left section contains a list of possible parameters the class supports. The right section contains the configuration options for the parameter selected.
4. Select a parameter from the left-hand list.
5. Edit the Description text box to add any plain text notes.
6. Select Override to allow Satellite control over this variable. If the check box is not selected, Satellite does not pass the new variable to Puppet.
7. Select the Key type of data to pass. This is most commonly a string, but other data types are supported.
8. Enter a Default Value for the parameter to be sent to the Puppet Master if no host match occurs.
9. Optionally select Use Puppet Default to not send a value to the Puppet Master unless an override match occurs.
10. Optionally select Hidden value if the field contains data you do not want to be displayed while you are working.
11. Use the Optional input validator section to restrict the allowed values for the parameter. Choose a Validator type (either a list of comma separated values or a regular expression, regexp) and input the allowed values or regular expression code in the Validator rule field.
12. The Prioritize attribute order section will appear if the Override option is selected. This provides options for overriding values for specific hosts based upon conditional arguments. The attribute type and its value is known as a matcher.
    1. Set the Order of precedence in which the host attributes or Facts are to be evaluated against the matchers by arranging the entries in the list. You can add to the default list. To create a logical AND condition between matchers, arrange them on one line as a comma separated list.
    2. Click Add Matcher to add a conditional argument. The attributes to match against should correspond to the entries in the Order list. If no matcher is configured then only the default value can be used for the override feature.
       For example, if the desired value of the parameter to be supplied to the Puppet Master is test for any host with a fully qualified domain name of server1.example.com, then specify the matcher as fqdn=server1.example.com and the Value as test.
       The precedence for matching is as follows:

       1. If the matcher is a host attribute, use that.
       2. If there are no attributes with that name, look for a matching host parameter (which is inherited according to the parameter hierarchy).
       3. If there is still no match, check the host Facts.

       It is recommend to use an attribute that is present in Facter and cannot be confused with a host attribute.
       Dynamic data is possible by using parameters and Puppet Facts in the Value field in Embedded Ruby (ERB) template syntax. For example, to use a Puppet Fact as part of the value:

       <%= @host.facts['network_eth0'] %>

       To list available Puppet Facts navigate to Monitor → Facts.
13. Click Submit to save your changes.

Procedure 9.6. To Create a Domain:

1. Click Infrastructure → Domains.
2. Click New Domain. On the Domain tab, specify the following settings:
   1. Specify a Name for the Domain. This is the required DNS domain name.
   2. Type a Description for the Domain.
   3. Select a DNS-enabled Capsule Server.
3. On the Parameters tab, specify domain parameters.
4. On the Locations tab, select locations for the domain.
5. On the Organizations tab, select organizations for the domain.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
6. Click Submit.

Procedure 9.8. To Create an Architecture:

1. Click Hosts → Architectures and then click New Architecture.
2. Specify a Name for the architecture.
3. Select any Operating Systems that include this architecture. If none are available, you can create and assign them under Hosts → Operating Systems.
4. Click Submit.

Procedure 9.9. To Add a Compute Resource:

1. Navigate to Infrastructure → Compute Resources.
2. Click New Compute Resource. On the Compute Resource tab, specify the following settings:
   1. Specify a Name and a Provider type for the Compute Resource. Optionally, insert a Description.
   2. Depending on the provider type chosen, the next few fields ask for authentication and datacenter details. Refer to the following table for more information about each provider type.

      Table 9.2. Provider Settings

      Type	Description
      RHEV	Suits Red Hat Enterprise Virtualization environments. Requires the URL of the Manager API, a valid Username and Password, and a Datacenter on the system to abstract compute resources. Click Load Datacenters to populate the drop-down menu. Optionally, you can specify a Quota ID and provide one or more certificate authorities in the X509 Certification Authorities field.
      Libvirt	Suits Libvirt-based environments. Requires the URL of the virtual machine. Select the Display type. Click Test Connection to test if the virtual machine is available. Select Console passwords to set a randomly generated password on the display connection.
      VMware	Suits VMware-based environments. Requires the host name of the VCenter/Server, a valid VMware Username and Password, and a Datacenter to abstract compute resources. Click Load Datacenters to populate the drop-down menu. You can specify a certificate Fingerprint and select Console passwords to set a randomly generated password on the display connection.
      RHEL OpenStack Platform	Suits OpenStack-based environments. Requires the URL of the OpenStack server, a valid OpenStack Username and Password, and a Tenant to abstract compute resources. Click Load Tenants to populate the drop-down menu.
      Rackspace	Suits Rackspace public cloud accounts. Requires the URL of the Rackspace API, a valid Rackspace Username and API Key, and a Region to abstract compute resources. Click Test Connection to make sure your connection to the chosen region is valid.
      EC2	Suits Amazon EC2 public cloud accounts. Requires the Access Key and Secret Key available from any valid Amazon EC2 account. Requires a Region to act as a Datacenter for resource abstraction. Click Load Regions to populate the selection drop-down menu.
      Google	Suits Google Compute Engine public cloud accounts. Requires the Google Project ID, a valid Client Email and a Certificate path to the p12 file. You can also specify a Zone to abstract compute resources. Click Load zones to populate the drop-down menu.
      Docker	Suits container registries. Requires the URL of the internal or external compute resource. Optionally, specify a Username, Password, and a contact Email. Click Test Connection to test if the connection is available.

3. On the Locations tab, select desired locations to add them to the Selected Items list.
4. On the Organizations tab, select the desired organizations to add them to the Selected Items list.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
5. Click Submit.

Procedure 9.10. To Add a Libvirt Compute Resource:

1. Navigate to Infrastructure → Compute resources.
2. Click New Compute Resource. On the Compute Resource tab, specify the following settings:
   1. Specify a Name and from the Provider drop-down menu, select Libvirt as the type for the Compute Resource. Optionally, insert a Description.
   2. In the URL field, enter a string as follows:

      qemu:///system

   3. From the Display Type drop-down menu, select VNC.
   4. Optionally select the Console passwords check box if this compute resource will only be used for new Libvirt guests. This option cannot be used together with previously configured Libvirt guests.
   5. Click Test Connection. If the connection is successful the button turns green.
   6. Click Submit to save the configuration.
   7. Select the Virtual Machines tab. Previously configured Libvirt guests will be shown.

Procedure 9.11. To Configure SSH Access to Libvirt:

1. Ensure the SSH file permissions and SELinux context for the foreman user are correct:

   # ls -Zd /usr/share/foreman/.ssh
   drwx------. foreman foreman system_u:object_r:ssh_home_t:s0  /usr/share/foreman/.ssh

2. Create SSH keys for the foreman user:

   # su - foreman -s /bin/bash
   -bash-4.2$ ssh-keygen
   Generating public/private rsa key pair.
   Enter file in which to save the key (/usr/share/foreman/.ssh/id_rsa):
   Enter passphrase (empty for no passphrase):
   Enter same passphrase again:
   Your identification has been saved in /usr/share/foreman/.ssh/id_rsa.
   Your public key has been saved in /usr/share/foreman/.ssh/id_rsa.pub.
   The key fingerprint is:
   07:47:a9:23:d2:fe:2f:07:fb:55:75:46:3e:8e:6e:69 foreman@satellite.example.com
   The key's randomart image is:
   +--[ RSA 2048]----+
   |          ..    .|
   |         ..    o |
   |     .  ...    .=|
   |    . o oo    ooo|
   |     o .S..  ... |
   |      . ..  ...  |
   |       . o  .E   |
   |        + ..o    |
   |         =o      |
   +-----------------+

3. Copy the SSH public key to the remote hypervisor system. For example, if your Libvirt host is kvm.example.com:

   -bash-4.2$ ssh-copy-id root@kvm.example.com
   The authenticity of host 'kvm.example.com (192.168.1.2)' can't be established.
   ECDSA key fingerprint is 78:79:41:d0:b8:40:d5:4a:6d:7f:22:03:bd:cd:a0:dd.
   Are you sure you want to continue connecting (yes/no)? yes
   /usr/bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed
   /usr/bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys
   foreman@192.168.1.2's password:
   
   Number of key(s) added: 1
   
   Now try logging into the machine, with:   "ssh 'root@kvm.example.com'"
   and check to make sure that only the key(s) you wanted were added.

4. Make an SSH connection to the remote system to confirm that no password prompt appears:

   -bash-4.2$ ssh root@kvm.example.com

   You should not be prompted for the password. The public key can be found in the .ssh/authorized_keys file on the remote system. Exit after successfully logging in and checking the keys:

   -bash-4.2$ exit

5. In the web UI, navigate to Infrastructure → Compute resources and click New Compute Resource.
6. In the Name field enter a suitable name.
7. From the Provider drop-down menu, select Libvirt.
8. In the URL field, enter a string in the following format:

   qemu+ssh://root@kvm.example.com/system

   Where kvm.example.com is the FQDN of your Libvirt host.
9. From the Display Type drop-down menu, select VNC.
10. Optionally select the Console passwords check box if this compute resource will only be used for new Libvirt guests. This option cannot be used together with previously configured Libvirt guests.
11. Click Test Connection. If the connection is successful the button turns green.
12. Click Submit to save the configuration.
13. Select the Virtual Machines tab. Previously configured Libvirt guests will be shown.

Procedure 9.12. To Configure the noVNC Console:

Prerequisites:

1. On the hypervisor host system, configure the firewall to allow VNC service on ports 5900 to 5930:
   • On Red Hat Enterprise Linux 6:

     # iptables -A INPUT -p tcp --dport 5900:5930 -j ACCEPT
     # service iptables save

   • On Red Hat Enterprise Linux 7:

     # firewall-cmd --add-port=5900-5930/tcp
     # firewall-cmd --add-port=5900-5930/tcp --permanent

2. In the browser used for the web UI, trust the Satellite Server certificate as follows:
   1. Visit the public downloads page of the Satellite Server, for example https://satellite.example.com/pub/, and click the certificate file katello-server-ca.crt.
   2. Select to trust the certificate for identifying websites.
3. In the browser used for the web UI, disable HTTP strict transport security (HSTS). HSTS is described in RFC 6797. For example, in Firefox, enter About:Config in the browser address bar and set the following boolean to True:

   network.websocket.allowInsecureFromHTTPS

4. Ensure you are using the FQDN in the browser for the web UI. NoVNC will not work if the domain name in the URL does not match the CN value in the certificate, which should be the same as the FQDN. Use a command as follows to check the CN value:

   # openssl x509 -text -noout -in /etc/pki/katello/certs/katello-apache.crt | grep CN
   Issuer: C=US, ST=North Carolina, L=Raleigh, O=Katello, OU=SomeOrgUnit, CN=satellite.example.com
   Subject: C=US, ST=North Carolina, O=Katello, OU=SomeOrgUnit, CN=satellite.example.com
   output truncated

5. Navigate to Infrastructure+Compute Resources. Select the name of a Libvirt resource. On the Virtual Machines tab, select the name of a Libvirt guest. Ensure the machine is powered on and then select Console. The console window appears after the noVNC handshake completes.

Procedure 9.13. To Create a Hardware Model:

1. Click Hosts → Hardware Models.
2. Click New Model.
3. Specify a Name for the Hardware Model.
4. For SPARC builds, insert the CPU Hardware model and Vendor class. Other architectures do not require values in these fields.
5. Type a description of the Hardware Model in the Information field.
6. Click Submit.

Procedure 9.14. To Add an Installation Medium:

1. Click Hosts → Installation Media.
2. Click New Medium. On the Medium tab, specify the following settings:
   1. Type a Name for the Installation Media. This setting is required.
   2. Type a Path to the Installation Medium. Options include either a URL or a valid NFS server. This setting is required.
   3. Select an Operating System Family to define the type of the Installation Medium.
3. On the Locations tab, select the desired locations to add them to the Selected Items list.
4. On the Organizations tab, select the desired organizations to add them to the Selected Items list.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
5. Click Submit.

Procedure 9.15. To Create a Partition Table:

1. Click Hosts → Partition Tables.
2. Click New Partition Table.
3. Type a Name for the partition table.
4. Optionally select Default. This check box defines if the partition is automatically associated with new organizations or locations.
5. Optionally select Snippet. This check box defines if the partition is a reusable snippet for other partition table layouts.
6. Select the operating system from the Operating system family drop-down list.
7. Specify the Layout of the partition table. You can enter the layout in the text area under Template editor or click Choose File to upload a template file.

   Note

   The format of the layout must match that for the intended operating system. For example, Red Hat Enterprise Linux 7.2 requires a layout that matches a kickstart file.
8. Use the Audit Comment field to add a summary of changes to the partition layout.
9. Click Submit.

Procedure 9.16. To Create a Provisioning Template:

1. Click Hosts → Provisioning Templates.
2. Click New Template. On the Provisioning Template tab, specify the following settings:
   1. Specify a Name for the template.
   2. Insert your template in the Template editor field. Alternatively, click Browse to upload the template. This replaces the content in the Template editor field with the content of your chosen file.
   3. Optionally, type a comment in the Audit Comment field. Satellite adds the comment to the template history to track changes. View the template history under the History tab.
3. On the Type tab, select Snippet to store the template code without defining it as particular script or template type, or select the type from the Type drop-down menu.
4. On the Association tab, select host groups, environments and operating systems to be associated with the template. Select the operating systems from the Applicable Operating Systems list. Click Add Combination and select a Hostgroup and Environment to limit the template's use. Note that associations are not available for templates of type snippet.
5. On the Association tab, you can view the history of existing templates. No history is available when creating a new template.
6. On the Locations tab, select locations for the template.
7. On the Organizations tab, select organizations for the template.

   Important

   Ensure that the Locations and Organizations are configured as they will help with future debugging.
8. Click Submit.

Procedure 9.17. To Configure a gPXE Provisioning Template:

1. Click Hosts → Provisioning templates.
2. Find the template Kickstart default PXELinux and select Clone.
3. Enter a name, for example, Kickstart default gPXELinux.
4. In the Template editor, search and replace @initrd with @host.url_for_boot(:initrd)
5. In the Template editor, search and replace @kernel with @host.url_for_boot(:kernel)
6. Select the Type tab. From the Type drop-down menu, select PXELinux.
7. On the Association tab, select host groups, environments and operating systems to be associated with the template. Select the operating systems from the Applicable Operating Systems list. Click Add Combination and select a Hostgroup and Environment to limit the template's use.
8. Click Submit.

Procedure 9.18. To Add an Operating System:

1. Click Hosts → Operating Systems.
2. Click New Operating system. On the Operating System tab, specify the following settings:
   1. Type the Name of the Operating System and its Major Version. These settings are required.
   2. Optionally, define the Minor Version, select the OS Family, and add a Description of the operating system.
   3. Select a Root password hash (MD5, SHA256, of SHA512).
   4. Select the Architectures from the list of available Architectures. If none are available, create and assign them under Hosts → Architectures as described in Section 9.3.3, “Architectures”.
3. On the Partition tables tab, select the applicable file system layouts from the list. For more information on creating partition tables, see Section 9.3.8, “Partition Tables”.
4. On the Installation Media tab, select the applicable installation media from the list. For more information on adding installation media, see Section 9.3.7, “Installation Media”.
5. On the Templates tab, you can assign provisioning templates when editing an existing operating system. This option is not available when creating a new operating system. For more information on creating provisioning templates, see Section 9.3.9, “Provisioning Templates”.
6. On the Parameters tab, you can add parameters for the operating system.
7. Click Submit.

Procedure 10.2. To Configure a Host for Registration:

1. Take note of the fully qualified domain name (FQDN) of the Satellite Server or Capsule Server, for example server.example.com.
2. On the host, open a terminal and log in as root.
3. Install the consumer RPM from the Satellite Server or Capsule Server to which the host is to be registered. The consumer RPM updates the content source location of the host and allows the host to download content from the content source specified in Red Hat Satellite.

   # rpm -Uvh http://server.example.com/pub/katello-ca-consumer-latest.noarch.rpm

   Important

   Any running Docker Daemons will be restarted.

   Note

   katello-ca-consumer-hostname-1.0-1.noarch.rpm is an additional katello-ca-consumer RPM available that contains the server's host name. The katello-ca-consumer-latest.noarch.rpm rpm will always reflect the most updated version. Both serve the same purpose.

Procedure 10.3. To Register Hosts:

1. On the host, open a terminal and log in as root.
2. Clear any old host data related to Red Hat Subscription Manager (RHSM):

   # subscription-manager clean
   

3. Register the host using RHSM:

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

   Example 10.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 10.5. To Verify the Satellite Tools Repository is Enabled:

1. Open the Satellite web UI, navigate to Content → Red Hat Repositories and click on the RPMs tab.
2. Find and expand the Red Hat Enterprise Linux Server item.
3. Find and expand the Red Hat Satellite Tools 6.2 (for RHEL VERSION Server) (RPMs) item.
   If the Red Hat Satellite Tools 6.2 items are not visible, it may be because they are not included in the subscription manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the subscription manifest and import it into Satellite.
4. Ensure the Enabled check box beside the repository's name is selected. If not, select it.

Procedure 10.6. To Install Katello Agent:

1. On the host, verify that the satellite-tools repository is enabled. If you registered the host using an activation key with auto-attache enabled, the repository is enabled automatically already.

   # yum repolist enabled | grep -i satellite-tools

   If the satellite-tools is not enabled, enable it using the following command:

   # subscription-manager repos --enable=rhel-version-server-satellite-tools-6.2-rpms

2. Install the katello-agent RPM package using the following command:

   # yum install katello-agent

3. Ensure the goferd service is running.
   • On Red Hat Enterprise Linux 6, enter the following command:

     # service goferd start

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

     # systemctl start goferd

Procedure 10.7. To Verify the Satellite Tools Repository is Enabled:

1. Open the Satellite web UI, navigate to Content → Red Hat Repositories and click on the RPMs tab.
2. Find and expand the Red Hat Enterprise Linux Server item.
3. Find and expand the Red Hat Satellite Tools 6.2 (for RHEL VERSION Server) (RPMs) item.
   If the Red Hat Satellite Tools 6.2 items are not visible, it may be because they are not included in the subscription manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the subscription manifest and import it into Satellite.
4. Ensure the Enabled check box beside the repository's name is selected. If not, select it.

Procedure 10.8. To Install and Enable the Puppet Agent:

1. On the host, open a terminal console and log in as the root user.
2. Verify that the satellite-tools repository is enabled, using the following command:

   # yum repolist enabled | grep -i satellite-tools

   If the satellite-tools is not enabled, enable it using the following command:

   # subscription-manager repos --enable=rhel-version-server-satellite-tools-6.2-rpms

3. Install the Puppet agent RPM package using the following command:

   # yum install puppet
   

4. Configure the puppet agent to start at boot:
   • On Red Hat Enterprise Linux 6:

     # chkconfig puppet on

   • On Red Hat Enterprise Linux 7:

     # systemctl enable puppet

Procedure 10.9. To Configure the Puppet Agent:

1. Configure the Puppet agent by specifying the server and environment settings in the /etc/puppet/puppet.conf file:

   # vi /etc/puppet/puppet.conf
   

   [main]
       # The Puppet log directory.
       # The default value is '$vardir/log'.
       logdir = /var/log/puppet
   
       # Where Puppet PID files are kept.
       # The default value is '$vardir/run'.
       rundir = /var/run/puppet
   
       # Where SSL certificates are kept.
       # The default value is '$confdir/ssl'.
       ssldir = /var/lib/puppet/ssl
   
   ...
   
   [agent]
       # The file in which puppetd stores a list of the classes
       # associated with the retrieved configuratiion.  Can be loaded in
       # the separate ``puppet`` executable using the ``--loadclasses``
       # option.
       # The default value is '$confdir/classes.txt'.
       classfile = $vardir/classes.txt
       pluginsync = true
       report = true
       ignoreschedules = true
       daemon = false
       ca_server = satellite.example.com
       server = satellite.example.com
       environment = KT_Example_Org_Library_RHEL6Server_3
   
       # Where puppetd caches the local configuration.  An
       # extension indicating the cache format is added automatically.
       # The default value is '$confdir/localconfig'.
       localconfig = $vardir/localconfig
   
   ...
   

   Important

   Set the environment parameter to the name of the Puppet environment to which the host belongs. A Puppet environment is a collection of Puppet modules that can be associated with a host or a host group.

   • To find the host's Puppet environment, navigate to Hosts → All Hosts and inspect the Environment column in the host table.
   • To assign a Puppet environment to a host, navigate to Hosts → All Hosts and click Edit next to the selected host.
   • To list Puppet environments enabled on the Satellite Server, navigate to Configure → Environments. You can also inspect the /etc/puppet/environments/ directory on the Satellite Server to find what Puppet modules and manifests are associated with Puppet environments.

   For more information see the Red Hat Satellite Puppet Guide.
2. Run the Puppet agent on the host:

   # puppet agent -t --server satellite.example.com

3. Sign the SSL certificate for the Puppet client through the Satellite Server web UI:
   1. Log in to the Satellite Server through the web UI.
   2. Select Infrastructure → Capsules.
   3. Select Certificates from the drop-down menu to the right of the required Capsule.
   4. Click Sign to the right of the required host.
   5. Enter the puppet agent command again:

      # puppet agent -t --server satellite.example.com

Procedure 10.10. Installing the Bootstrap Script on the Host:

1. Ensure you are in the correct directory. For example, to change to /root:

   # cd

2. Download the script:

   # wget http://satellite6.example.com/pub/bootstrap.py

   This will install the script to the current directory.
3. Make the script executable:

   # chmod +x bootstrap.py

4. To confirm that the script can now be run, view the usage statement as follows:

   # ./bootstrap.py -h

5. Optionally, when the transition process is complete, remove the script:

   # cd
   # rm bootstrap.py

Procedure 10.11. Running the Bootstrap Script

Prerequisites

1. Enter the bootstrap command as follows with values suitable for your environment.
   For the --server option, specify the FQDN name of Satellite Server or Capsule Server. For --location, --organization, and --hostgroup options, use quoted names, not labels, as arguments to the options. See Section 10.5.6, “Advanced Bootstrap Script Configuration” for advanced use cases.

   # bootstrap.py --login=admin \
   --server satellite6.example.com \
   --location="Example Location" \
   --organization="Example Organization" \
   --hostgroup="Example Host Group" \
   --activationkey=activation_key

   The script will prompt you for the password corresponding to the Satellite user name you entered with the --login option.
2. The script will run and send notices of progress to stdout. Watch for output prompting you to approve the certificate. For example:

   [NOTIFICATION], [2016-04-26 10:16:00], [Visit the UI and approve this certificate via Infrastructure->Capsules]
   [NOTIFICATION], [2016-04-26 10:16:00], [if auto-signing is disabled]
   [RUNNING], [2016-04-26 10:16:00], [/usr/bin/puppet agent --test --noop --tags no_such_tag --waitforcert 10]

   The host will wait indefinitely until an administrator approves the Puppet certificate.
   1. In the web UI, navigate to Infrastructure → Capsules.
   2. Select Certificates to the right of the name of the Capsule corresponding to the FQDN given with --server option.
   3. In the Actions column select Sign to approve the host's Puppet certificate.
   4. Return to the host to see the remainder of the bootstrap process completing.
3. In the web UI, navigate to Hosts → All hosts and ensure that the host is connected to the correct host group.

Procedure 10.12. To Add a Physical Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Keep the Interface option selected in the Type menu.
5. Specify a MAC address of the additional interface. This setting is required.
6. Specify the device Identifier, for example eth0 or eth1.1. Identifier is used for bonded interfaces (in the Attached devices field, see Procedure 10.14, “To Add a Bonded Interface:”), VLANs and aliases (in the Attached to field, see Procedure 10.13, “To Add a Virtual Interface:”).
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 drop-down menu. To create and manage domains, navigate to Infrastructure → Domains.
9. Select a subnet from the Subnet drop-down menu. To create and manage subnets, navigate to Infrastructure → Subnets.
10. Specify the interface IP address. Managed interfaces with assigned DHCP Capsule Server require this setting for creating a DHCP lease. DHCP-enabled managed interfaces provide an automatic suggestion of IP address.
11. Decide if the interface will be managed. If the Managed check box is selected, the interface 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 the Virtual NIC check box to create a virtual interface. See Section 10.11.2, “Adding a Virtual Interface” for details.
13. Click OK to save the interface configuration, and then click Submit to apply the changes to the host.

Procedure 10.13. To Add a Virtual Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Keep the Interface option selected in the Type menu.
5. Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Section 10.11.1, “Adding a Physical Interface”.
   Specify MAC address for managed virtual interfaces so that the configuration files for provisioning are generated correctly. However, 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 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: You can specify tags per interface to provide a higher-level segmentation of the network. If left blank, managed interfaces inherit the tag form the VLAN ID of the associated subnet, given that this subnet has the VLAN ID specified. User-specified entries from this field are not applied on 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. Then click Submit to apply the changes to the host.

Procedure 10.14. To Add a Bonded Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Select Bond from the Type menu. 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 10.11.1, “Adding a Physical Interface”. Bonded interfaces use IDs in the form of bond0 in the Identifier field. It is sufficient if you specify a single MAC address in the MAC address field.
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 10.2, “Bonding Modes Available in Red Hat Satellite” for a brief description of individual bonding modes.
   • 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. There are several configuration options you can specify for the bonded interface, see Red Hat Enterprise Linux 7 Networking Guide for details.
7. Click OK to save the interface configuration. Then click Submit to apply the changes to the host.

Procedure 10.15. To Enable BMC Power Management on an Existing Capsule Server:

1. Use the satellite-installer routine to configure BMC power management on the Capsule Server by running the following command with the following options:

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

2. Refresh the features for the Capsule Server.
   1. Log in to the Satellite web UI, and navigate to Infrastructure → Capsules.
   2. Identify the Capsule Sever whose features you need to refresh. In the drop-down list on the right, click Refresh features. The list of features in the Features column should now include BMC.

Procedure 10.16. To Add a BMC Interface:

1. Navigate to Hosts → All hosts to view available hosts.
2. Click Edit next to the host you want to edit.
3. On the Network tab, click Add Interface.
4. Select BMC from the Type menu. 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 10.11.1, “Adding a Physical Interface”.
6. Specify the configuration options specific to BMC interfaces:
   • Username, Password: Specify any authentication credentials required by BMC.
   • Provider: Specify the BMC provider.
7. Click OK to save the interface configuration, and then click Submit to apply the changes to the host.

Procedure 11.1. To Configure PXE-booting:

1. In the Satellite web UI, navigate to Hosts → Provisioning Templates.
2. Edit the PXELinux global default template. Add the following menu entry to the template:

   LABEL discovery
   MENU LABEL Foreman Discovery
   MENU DEFAULT
   KERNEL boot/fdi-image-rhel_7-vmlinuz
   APPEND initrd=boot/fdi-image-rhel_7-img rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=https://SATELLITE_CAPSULE_URL:9090 proxy.type=proxy
   IPAPPEND 2

3. Set the new menu entry to be the default by modifying the ONTIMEOUT variable:

   ONTIMEOUT discovery

4. Click Build PXE Default at the top of the Provisioning Templates page. This instructs the TFTP proxy to rewrite the pxelinux.cfg/default file. Repeat this step every time a change is made to the default template to ensure that the changes are deployed on the TFTP Satellite Capsule Server.

Procedure 11.2. To Manually Provision a Discovered Host:

1. Navigate to Hosts → Discovered Hosts.
2. Select the host you want to provision and click Provision.
3. On the host's Edit page, complete the necessary details, and then click Save.

Procedure 11.3. To Decommission a Discovered Host:

1. Shut down the host.
2. Navigate to Hosts → Discovered Hosts.
3. In the Name column find the host you want to decommission and then select Delete from the corresponding Edit drop-down menu.

Procedure 11.4. To Create a Provisioning Rule:

1. Navigate to Configure → Discovery rules.
2. Click New Rule. Specify the following parameters of the provisioning rule:
   • Name is the name of the rule displayed in the list of rules. This name must not contain spaces or non-alphanumeric characters.
   • Search is the search statement used to match discovered hosts for the particular rule. You can use scoped search syntax to define it. See Section 11.3.4, “Scoped Search Syntax” for examples of using scoped search.
   • Host Group is the host group to be assigned to a matching host before starting the provisioning process. Make sure that the selected host group has all the required parameters set; required parameters are marked with an asterisk (*).
   • Hostname defines a pattern for assigning human-readable host names to the matching hosts. When left blank, the host name is assigned in the format "macMACADDRESS" by default. The same syntax used for provisioning templates is used in this instance. See Section 11.3.5, “Host Name Patterns” for more information and examples.
   • Hosts limit is the maximum number of provisioned hosts per rule. If the limit is reached, the rule will not take effect until one or more hosts are deleted. Typical use cases are rules per server rack or row when it is necessary to change provisioning parameters such as host name or host group per entry. You can set this value to zero (0) to specify no limit.
   • Priority specifies the order of execution of rules. The value must be greater than or equal to zero. A lower value indicates a higher priority. If two rules have the same priority, the first rule encountered is applied.
   • Enabled provides the option to temporarily enable or disable rules.
3. Click Submit to save the rule.

Procedure 11.5. To Enable Automatic Provisioning:

1. Navigate to Administer → Settings → Discovered in the Satellite web UI.
2. Locate discovery_auto in the Name column, and set its value to true.
3. Click Save.

Procedure 12.1. To Create a Job Template:

1. Navigate to Hosts → Job templates.
2. Click New Job Template. As an alternative, you can modify an existing template – in the Actions column, select Clone from the drop-down menu.
3. Configure the job template:
   1. On the Template tab, enter a unique name for your job template. Select Default to make the template available for all organizations and locations. You can insert the template manually using Template editor or upload it from a text file by clicking Browse. Templates use Embedded Ruby (ERB) template syntax, see Section 12.2.4, “Creating Advanced Templates” for more information. An advanced template is required, for example, for executing jobs that perform power actions; see Example 12.4, “Including Power Actions in Templates” for information on how to include the Power Action - SSH Default template in a custom template.
   2. On the Job tab, you can define the job category (define your own or select from the default categories listed in Table 12.1, “Default Job Template Categories”) as well as the effective user; these settings can be configured also when invoking the job (see Procedure 12.2, “To Execute a Remote Job:”). You can also define input parameters for template commands. These parameters are then requested when executing the job.
   3. Remaining tabs enable setting the template type, organizations and locations as well as viewing the template history.
4. Click Submit. When the page refreshes, your new template should appear in the list of job templates.

Procedure 12.2. To Execute a Remote Job:

1. Navigate to Hosts → All hosts and select the target hosts for your job. You can use the search field to narrow down the host list.
2. From the Select Action menu at the upper right of the screen select Run Job. This will take you to the Job invocation page. Alternatively, if you target just one host, click its name and click Run Job on the host information page. Note that you can invoke jobs also from the Job Templates page by using the Run button.
3. On the Job invocation page, define the main job settings:
   1. Select the Job category and the Job template you want to use. These settings are required.
   2. Optionally, select a stored search string in the Bookmark list to specify the target hosts.
   3. Optionally, further limit the targeted hosts by inserting 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 will list the targeted hosts.
   4. The remaining settings depend on the selected job template. See Procedure 12.1, “To Create a Job Template:” for information on adding custom parameters to a template.
4. Clicking Display advanced fields will show advanced setting for the job. 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 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.
   • Time span 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.
   Concurrency level and Time span settings enable you to tailor job execution to fit your infrastructure hardware and needs.
5. If you want to execute 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 Automating System Tasks section of the Red Hat Enterprise Linux 7 System Administrator's Guide.
6. Click Submit. This displays the Job Overview page, and when the job completes, also displays the status of the job.

Procedure 12.3. To Monitor a Job:

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.

Procedure 13.3. To Add Packages to Host Collections:

1. Click Hosts → Host Collections.
2. Click the host collection where the package should be added.
3. On the Collection Actions tab, click Package Installation, Removal, and Update.
4. To update all packages, click the Update All Packages button to use the default method. Alternatively, select the drop-down icon to the right of the button to select a method to use. Selecting the via remote execution - customize first menu entry will take you to the Job invocation page where you can customize the action.
5. Select the Package or Package Group radio button as required.
6. In the field provided, specify the package or package group name. Then click:
   • Install — to install a new package using the default method. Alternatively, select the drop-down icon to the right of the button and select a method to use. Selecting the via remote execution - customize first menu entry will take you to the Job invocation page where you can customize the action.
   • Update — to update an existing package in the host collection using the default method. Alternatively, select the drop-down icon to the right of the button and select a method to use. Selecting the via remote execution - customize first menu entry will take you to the Job invocation page where you can customize the action.

Procedure 13.4. To Add Errata to a Host Collection:

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