Managing Hosts

In the Foreman web UI, click Hosts > Create Host.

On the Host tab, enter the required details.

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.

On the Puppet Classes tab, select the Puppet classes you want to include.

On the Interfaces tab:

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.

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.

On the Additional Information tab, enter additional information about the host.

Click Submit to complete your provisioning request.

In the Foreman web UI, navigate to Hosts > All Hosts.

In the Actions menu, click Clone.

On the Host tab, ensure to provide a Name different from the original host.

On the Interfaces tab, ensure to provide a different IP address.

Click Submit to clone the host.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select a compute resource.

On the Virtual Machines tab, click Associate VM from the Actions menu.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Content tab, then click the Module streams tab.

Click the vertical ellipsis next to the module and select the action you want to perform. You get a REX job notification once the remote execution job is complete.

In the Foreman web UI, navigate to Configure > Host Groups and click Create Host Group.

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.

Enter a Name for the new host group.

Enter any further information that you want future hosts to inherit.

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.

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

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

Click Submit to save the host group.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Edit button.

Select the host group from the Host Group list.

Click Submit.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Edit button.

Select the new host group from the Host Group list.

Click Submit.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

In the Host collections card, click the vertical ellipsis and select Add host to collections.

Select the host collection.

Click Add.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the vertical ellipsis icon next to the Edit button and select Change content source.

Select Environment, Content View, and Content Source from the lists.

Click Change content source.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the vertical ellipsis in the Content view details card and select Edit content view assignment.

Select the environment.

Select the content view.

Click Save.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Edit button.

Click Manage host or Unmanage host to change the host’s status.

Click Submit.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Traces tab, then click the Enable Traces button.

Select the provider to install katello-host-tools-tracer from the list.

Click the Enable Tracer button. You get a REX job notification once the remote execution job is complete.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the hosts you want to modify.

Select the Traces tab.

Select applications that you want to restart.

Select Restart via remote execution from the Restart app list. You will get a REX job notification once the remote execution job is complete.

In the Foreman web UI, navigate to Hosts > All Hosts.

Select the checkbox of the host you want to change.

From the Select Action list, select Assign Organization. A new option window opens.

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

Click Submit.

In the Foreman web UI, navigate to Hosts > All Hosts.

Select the checkbox of the host you want to change.

From the Select Action list, select Assign Location. A new option window opens.

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

Click Submit.

In the Foreman web UI, navigate to Hosts > Content Hosts

Click the content host you want to view.

Select the Details tab to see the host details page.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click Manage columns.

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

In the Foreman 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, Foreman removes a host completely.

Select the hosts that you want to remove.

From the Select Action list, select Delete Hosts.

Click Submit to remove the host from Foreman permanently.

In the Foreman web UI, navigate to Hosts > All Hosts and select a host.

In the Snapshots card, click Create Snapshot.

Enter a Name.

Optional: Enter a Description.

Optional: In the Snapshot Mode field, select Memory if you want to include the RAM in your snapshot or Quiecse if you want to ensure the full state of the VM is written to disk before creating the snapshot.

Click Submit to create a snapshot.

Install the katello-agent package:

# dnf install katello-agent

Start the goferd service:

# systemctl start goferd

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

# yum install katello-host-tools-tracer

Enter the following command:

# katello-tracer-upload

In the Foreman web UI, navigate to Hosts > All Hosts, then click the required host name.

Click the Traces tab to view Traces. If it is not installed, an Enable Traces button initiates a remote execution job that installs the package.

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

Enable the Puppet agent using a host parameter in global parameters or a host group. Add a host parameter named enable-puppet7, select the boolean type, and set the value to true.

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

Navigate to Hosts > Register Host and register your host using an appropriate activation key. For more information, see Registering Hosts in Managing Hosts.

Navigate to Infrastructure > Smart Proxies.

From the list in the Actions column for the required Smart Proxy server, select Certificates.

Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

Log in to the host as the root user.

Install the Puppet agent package.

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

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

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

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

Start the Puppet agent service:

# puppet resource service puppet ensure=running enable=true

Create a certificate for the host:

# puppet ssl bootstrap

In the Foreman web UI, navigate to Infrastructure > Smart Proxies.

From the list in the Actions column for the required Smart Proxy server, select Certificates.

Click Sign to the right of the required host to sign the SSL certificate for the Puppet agent.

On the host, run the Puppet agent again:

# puppet ssl bootstrap

Create a host group with Ansible roles. For more information, see Creating a Host Group.

Register the host by using the host group with assigned Ansible roles. For more information, see Registering a Host.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click Edit next to the host you want to edit.

On the Interfaces tab, click Add Interface.

Keep the Interface option selected in the Type list.

Specify a MAC address. This setting is required.

Specify the Device Identifier, for example eth0. The identifier is used to specify this physical interface when creating bonded interfaces, VLANs, and aliases.

Specify the DNS name associated with the host’s IP address. Foreman saves this name in Smart Proxy server associated with the selected domain (the "DNS A" field) and Smart Proxy server associated with the selected subnet (the "DNS PTR" field). A single host can therefore have several DNS entries.

Select a domain from the Domain list. To create and manage domains, navigate to Infrastructure > Domains.

Select a subnet from the Subnet list. To create and manage subnets, navigate to Infrastructure > Subnets.

Specify the IP address. Managed interfaces with an assigned DHCP Smart Proxy server require this setting for creating a DHCP lease. DHCP-enabled managed interfaces are automatically provided with a suggested IP address.

Select whether the interface is Managed. If the interface is managed, configuration is pulled from the associated Smart Proxy server during provisioning, and DNS and DHCP entries are created. If using kickstart provisioning, a configuration file is automatically created for the interface.

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.

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.

Select whether to use the interface for Remote execution.

Leave the Virtual NIC checkbox clear.

Click OK to save the interface configuration.

Click Submit to apply the changes to the host.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click Edit next to the host you want to edit.

On the Interfaces tab, click Add Interface.

Keep the Interface option selected in the Type list.

Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Adding a Physical Interface.

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

Click OK to save the interface configuration.

Click Submit to apply the changes to the host.

In the Foreman web UI, navigate to Hosts > All Hosts.

Click Edit next to the host you want to edit.

On the Interfaces tab, click Add Interface.

Select Bond from the Type list. Additional type-specific configuration options are appended to the form.

Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Adding a Physical Interface.

Specify the configuration options specific to bonded interfaces:

Click OK to save the interface configuration.

Click Submit to apply the changes to the host.

Enable BMC on the Smart Proxy server if it is not already enabled:

In the Foreman web UI, navigate to Hosts > All Hosts.

Click Edit next to the host you want to edit.

On the Interfaces tab, click Add Interface.

Select BMC from the Type list. Type-specific configuration options are appended to the form.

Specify the general interface settings. The applicable configuration options are the same as for the physical interfaces described in Adding a Physical Interface.

Specify the configuration options specific to BMC interfaces:

Click OK to save the interface configuration.

Click Submit to apply the changes to the host.

In the Foreman web UI, navigate to Hosts > All Hosts and select the host that you want to manage and monitor with Cockpit.

In the upper right of the host window, click the vertical ellipsis and select Web Console.

Run this foreman-installer command:

foreman-installer --no-enable-foreman-plugin-remote-execution-cockpit

In the Foreman web UI, navigate to Administer > Settings and click the Remote execution tab.

In the Cockpit URL row, erase the setting under Value and click Submit. This removes the Web Console button from the Foreman web UI.

Uninstall the Cockpit package from Foreman:

dnf remove rubygem-foreman_remote_execution-cockpit

foreman-installer --foreman-proxy-plugin-remote-execution-script-cockpit-integration=false

In the Foreman web UI, navigate to Monitor > Jobs and click Run job.

Select Katello as Job category and Install Package – Katello Script Default as Job template and click Next.

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

In the package field, enter kernelcare and click Next.

Optional: To configure advanced settings for the job, fill in the Advanced fields. To learn more about advanced settings, see Advanced Settings in the Job Wizard.

Click Next.

Select Immediate execution to execute the job immediately and click Next.

Review job details. You have the option to return to any part of the job wizard and edit the information.

Click Run to install kernelcare on your managed hosts.

In the Foreman web UI, navigate to Monitor > Jobs and click Run job.

Select LivePatching – Script Default as Job category and LivePatching – Kernel version as Job template and click Next.

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

Click Next.

Optional: To configure advanced settings for the job, fill in the Advanced fields. To learn more about advanced settings, see Advanced Settings in the Job Wizard.

Click Next.

Select Immediate execution to execute the job immediately and click Next.

Review job details. You have the option to return to any part of the job wizard and edit the information.

Click Run to view the running Kernel version on your managed hosts.

In the Foreman web UI, navigate to Monitor > Jobs and click Run job.

Select LivePatching – Script Default as Job category and LivePatching – Update kernel as Job template and click Next.

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

Click Next.

Optional: To configure advanced settings for the job, fill in the Advanced fields. To learn more about advanced settings, see Advanced Settings in the Job Wizard.

Click Next.

Select Immediate execution to execute the job immediately and click Next.

Review job details. You have the option to return to any part of the job wizard and edit the information.

Click Run to update to the latest Linux kernel on your managed hosts.

In the Foreman web UI, navigate to Monitor > Report Templates. For example, the following templates are available:

To the right of the report template that you want to use, click Generate.

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.

Optional: To send a report to an e-mail address, select the Send report via e-mail checkbox, and in the Deliver to e-mail addresses field, enter the required e-mail address.

Optional: Apply search query filters. To view all available results, do not populate the filter field with any values.

Click Submit. A CSV file that contains the report is downloaded. If you have selected the Send report via e-mail checkbox, the host monitoring report is sent to your e-mail address.

List all available report templates:

# hammer report-template list

Generate a report:

# hammer report-template generate --id My_Template_ID

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

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

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

In the Name field, enter a unique name for your report template.

If you want the template to be available to all locations and organizations, select Default.

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 Importing Report Templates.

Optional: In the Audit Comment field, you can add any useful information about this template.

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.

Select whether the input value is mandatory. If the input value is mandatory, select the Required checkbox.

From the Value Type list, select the type of input value that the user must input.

Optional: If you want to use facts for template input, select the Advanced checkbox.

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.

Optional: In the Default field, enter a value, for example, a host name, that you want to set as the default template input.

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.

Optional: Click the Type tab, and select whether this template is a snippet to be included in other templates.

Click the Location tab and add the locations where you want to use the template.

Click the Organizations tab and add the organizations where you want to use the template.

Click Submit to save your changes.

In the Foreman web UI, navigate to Monitor > Report Templates.

Locate the template that you want to export, and from the list in the Actions column, select Export.

Repeat this action for every report template that you want to download.

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

# hammer report-template list

To export a report template, enter the following command:

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

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

$ curl --insecure --user admin:redhat \
--request GET \
--config https://foreman.example.com/api/report_templates \
| json_reformat

{
    "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
        }
    ]
}

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

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

In the Foreman web UI, navigate to Monitor > Report Templates.

In the upper right of the Report Templates window, click Create Template.

On the upper right of the Editor tab, click the folder icon, and select the .erb file that you want to import.

Edit the template to suit your requirements.

Click Submit.

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
"
}

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

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://foreman.example.com/api/report_templates/import

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

$ curl --insecure --user admin:redhat \
 --request GET --config https://foreman.example.com/api/report_templates | json_reformat

In the Foreman web UI, navigate to Monitor > Report Templates.

To the right of Host - All Installed Packages, click Generate.

Optional: Use the Hosts filter search field to search for and apply specific host filters.

Click Generate.

If the download does not start automatically, click Download.

In the Foreman web UI, navigate to Hosts > Host Collections.

Click New Host Collection.

Add the Name of the host collection.

Clear Unlimited Content Hosts, and enter the desired maximum number of hosts in the Limit field.

Add the Description of the host collection.

Click Save.

In the Foreman web UI, navigate to Hosts > Host Collections.

On the left hand panel, click the host collection you want to clone.

Click Copy Collection.

Specify a name for the cloned collection.

Click Create.

In the Foreman web UI, navigate to Hosts > Host Collections.

Select the host collection that you want to remove.

Under Select Action, click Remove.

Click Delete to remove the host collection.

In the Foreman web UI, navigate to Hosts > Host Collections.

Select the host collection where the host should be added.

On the Hosts tab, select the Add subtab.

Select the hosts to be added from the table and click Add Selected.

In the Foreman web UI, navigate to Hosts > Host Collections.

Choose the desired host collection.

On the Hosts tab, select the List/Remove subtab.

Select the hosts you want to remove from the host collection and click Remove Selected.

Connect to your Foreman using SSH:

# ssh root@foreman.example.com

Install the Salt plugin:

# foreman-installer \
--enable-foreman-plugin-salt \
--enable-foreman-proxy-plugin-salt

Create a global parameter called vendor_name with the string Foreman as its value.

Add a new Salt State called motd to your Salt Master.

Create the /srv/salt/motd/ directory:

# mkdir -p /srv/salt/motd/

Create /srv/salt/motd/init.sls as a Salt State file:

/etc/motd:
  file.managed:
    - user: root
    - group: root
    - mode: 0644
    - source: salt://motd/motd.template
    - template: jinja

Create /srv/salt/motd/motd.template as a template referenced by the Salt State file:

Welcome to {{ grains['fqdn'] }} Powered by {{ salt['pillar.get']('vendor_name') }}

Import the motd Salt State into Foreman.

Verify that Salt has been given access to the vendor_name parameter by running either of the following commands on your Salt Master:

# salt '*' pillar.items | grep -A 1 vendor_name
# salt '*' pillar.get vendor_name

# salt '*' saltutil.refresh_pillar

Add the motd Salt State to your Salt Minions or a host group.

Apply the Salt State by running state.highstate.

Optional: Verify the contents of /etc/motd on a Salt Minion.

Foreman finds the host’s interfaces that have the Remote execution checkbox selected.

Foreman finds the subnets of these interfaces.

Foreman finds remote execution Smart Proxies assigned to these subnets.

From this set of Smart Proxies, Foreman selects the Smart Proxy that has the least number of running jobs. By doing this, Foreman ensures that the jobs load is balanced between remote execution Smart Proxies.

Install the katello-pull-transport-migrate package on your host:

Optional: To verify that the pull client is running and configured properly, check the status of the yggdrasild service:

# systemctl status yggdrasild

Optional: After the package is installed, you can remove katello-agent from the host.

In the Foreman web UI, navigate to Hosts > Job templates.

Click New Job Template.

Click the Template tab, and in the Name field, enter a unique name for your job template.

Select Default to make the template available for all organizations and locations.

Create the template directly in the template editor or upload it from a text file by clicking Import.

Optional: In the Audit Comment field, add information about the change.

Click the Job tab, and in the Job category field, enter your own category or select from the default categories listed in Default Job Template Categories in Managing Hosts.

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.

From the Provider Type list, select SSH for shell scripts and Ansible for Ansible tasks or playbooks.

Optional: In the Timeout to kill field, enter a timeout value to terminate the job if it does not complete.

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.

Optional: Click Foreign input set to include other templates in this job.

Optional: In the Effective user area, configure a user if the command cannot use the default remote_execution_effective_user setting.

Optional: If this template is a snippet to be included in other templates, click the Type tab and select Snippet.

Click the Location tab and add the locations where you want to use the template.

Click the Organizations tab and add the organizations where you want to use the template.

Click Submit to save your changes.

Fetch the available Ansible playbooks by using the following API request:

# curl -X GET -H 'Content-Type: application/json' https://foreman.example.com/ansible/api/v2/ansible_playbooks/fetch?proxy_id=My_smart-proxy_ID

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

Import the Ansible playbook by its name:

# curl -X PUT -H 'Content-Type: application/json' -d '{ "playbook_names": ["My_Playbook_Name"] }' https://foreman.example.com/ansible/api/v2/ansible_playbooks/sync?proxy_id=My_smart-proxy_ID

In the Foreman web UI, navigate to Administer > Settings.

Click Remote Execution.

Configure the Fallback to Any Smart Proxy setting.

In the Foreman web UI, navigate to Administer > Settings.

Click Remote Execution.

Configure the Enable Global Smart Proxy setting.

On your host, create a new directory:

# mkdir /My_Remote_Working_Directory

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

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

Configure your Foreman server or Smart Proxy server to use the new directory:

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

Create a new directory:

# mkdir /My_Remote_Working_Directory

Access the yggdrasild service configuration:

# systemctl edit yggdrasild

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

Environment=FOREMAN_YGG_WORKER_WORKDIR=/My_Remote_Working_Directory

Restart the yggdrasild service:

# systemctl restart yggdrasild

Navigate to Administer > Settings.

Select the Remote Execution tab.

Click the value of the Effective User Method setting.

Select the new value.

Click Submit.

Distributing SSH Keys for Remote Execution Manually.

Using the Foreman API to Obtain SSH Keys for Remote Execution.

Configuring a Kickstart Template to Distribute SSH Keys During Provisioning.

For new Foreman hosts, you can deploy SSH keys to Foreman hosts during registration using the global registration template. For more information, see Registering a Host to Foreman Using the Global Registration Template in Managing Hosts.

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

# mkdir ~/.ssh

Download the SSH key from Smart Proxy:

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

Configure permissions for the ~/.ssh directory:

# chmod 700 ~/.ssh

Configure permissions for the authorized_keys file:

# chmod 600 ~/.ssh/authorized_keys

Find the ID of the foreman-proxy user:

# id -u foreman-proxy

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

# umask 077

Create the directory for the keytab:

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

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

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

Change the directory owner to the foreman-proxy user:

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

Ensure that the keytab file is read-only:

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

Restore the SELinux context:

# restorecon -RvF /var/kerberos/krb5

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

# foreman-installer --scenario katello \
--foreman-proxy-plugin-remote-execution-script-ssh-kerberos-auth true

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

Navigate to remote_execution_effective_user and edit the second column to add the user name for the Kerberos account.

To clone a template, in the Actions column, select Clone.

Enter a unique name for the clone and click Submit to save the changes.

In the Foreman web UI, navigate to Monitor > Jobs and click Run job.

Select the Job category and the Job template you want to use, then click Next.

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

hostgroup_fullname ~ "My_Host_Group*"

If required, provide inputs for the job template. Different templates have different inputs and some templates do not have any inputs. After entering all the required inputs, click Next.

Optional: To configure advanced settings for the job, fill in the Advanced fields. To learn more about advanced settings, see Advanced Settings in the Job Wizard.

Click Next.

Schedule time for the job.

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

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

Review job details. You have the option to return to any part of the job wizard and edit the information.

Click Submit to schedule the job for execution.

Enter the following command on Foreman:

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

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

# hammer job-template list

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

# hammer job-template info --id My_Template_ID

Execute a remote job with custom parameters:

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

In the Foreman web UI, navigate to Hosts > All Hosts and select the target host on which you want to execute a remote job.

On the Ansible tab, select Jobs.

Click Schedule recurring job.

Define the repetition frequency, start time, and date of the first run in the Create New Recurring Ansible Run window.

Click Submit.

Optional: View the scheduled Ansible job in host overview or by navigating to Ansible > Jobs.

In the Foreman web UI, navigate to Configure > Host groups.

In the Actions column, select Configure Ansible Job for the host group you want to schedule an Ansible roles run for.

Click Schedule recurring job.

Define the repetition frequency, start time, and date of the first run in the Create New Recurring Ansible Run window.

Click Submit.

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

On the Job page, click the Hosts tab. This displays the list of hosts on which the job is running.

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.

Click Back to Job at any time to return to the Job Details page.

Find the ID of a job:

# hammer job-invocation list

Monitor the job output:

# hammer job-invocation output \
--host My_Host_Name \
--id My_Job_ID

Optional: To cancel a job, enter the following command:

# hammer job-invocation cancel \
--id My_Job_ID

To enable the plug-in on your Foreman server, enter the following command:

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

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

Disable the plug-in using the Foreman installer:

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

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

# foreman-rake templates:cleanup

Uninstall the plug-in:

# dnf remove foreman-plugin-templates

In the Foreman web UI, navigate to Hosts > All Hosts,

Select the host name.

Click the Content tab.

Click the Repository Sets tab.

Click the vertical ellipsis to choose Override to disabled or Override to enabled to disable or enable repositories on hosts.

In the Foreman web UI, navigate to Hosts > All Hosts and select the host you want to install packages on.

On the Content tab, select the Packages tab.

On the vertical ellipsis icon next to the upgrade button, click Install Packages.

In the Install packages window, select the package or packages that you want to install on the host.

Click Install.

Create the "job_invocation" object and place rest of the body inside this object.

Create the "inputs" object with the "package" field of the string type specifying the packages you want to install. If you are specifying multiple packages, separate them with a whitespace.

Create a "feature" field of the string type with value "katello_package_install".

Create a "search_query" field of the string type and input a search query matching the hosts on which you want to install the packages.

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

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

Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.

Optional: If you want to install packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

Send a POST request with the created body to the /api/job_invocations endpoint of your Foreman server and use a tool like python to see a formatted response.

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

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Content tab, then click the Packages tab.

Select Upgradable from the Status list.

Select upgrade version from the dropdown menu in Upgradable to column where applicable.

Select the packages you want to upgrade.

Click the Upgrade button. You get a REX job notification once the remote execution job is complete.

Create the "job_invocation" object and place rest of the body inside this object.

Create the "inputs" object with the "package" field of the string type specifying the packages you want to update. If you are specifying multiple packages, separate them with a whitespace.

Create a "feature" field of the string type with value "katello_package_update".

Create a "search_query" field of the string type and input a search query matching the hosts on which you want to update the packages.

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

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

Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.

Optional: If you want to update packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

Send a POST request with the created body to the /api/job_invocations endpoint of your Foreman server and use a tool like python to see a formatted response.

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

In the Foreman web UI, navigate to Hosts > All Hosts.

Click the name of the host you want to modify.

Click the Content tab, then click the Packages tab.

Click the vertical ellipsis for the package you want to remove and select Remove. You get a REX job notification once the remote execution job is complete.

Create the "job_invocation" object and place rest of the body inside this object.

Create the "inputs" object with the "package" field of the string type specifying the packages you want to remove. If you are specifying multiple packages, separate them with a whitespace.

Create a "feature" field of the string type with value "katello_package_remove".

Create a "search_query" field of the string type and input a search query matching the hosts on which you want to remove the packages.

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

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

Optional: If you want to limit the number of hosts on which the job is run concurrently, create the "concurrency_control" object with the "concurrency_level" field of the integer type. Assign the number of hosts as the field value.

Optional: If you want to remove packages at a later time and you want the host search query to be evaluated at a time of running the job, create a "targeting_type" field of the string type with the "dynamic_query" value. This is useful if you expect the result of the search query to be different at the time of running the job due to changed status of the hosts. If you omit this field, it defaults to "static_query".

Send a POST request with the created body to the /api/job_invocations endpoint of your Foreman server and use a tool like python to see a formatted response.

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

Log in to the Foreman web UI.

In the Foreman web UI, navigate to Administer > About.

Click the Templates DSL link in the Support section.

In the Foreman web UI, navigate to either Hosts > Partition tables, Hosts > Provisioning templates, or Hosts > Job templates.

Click the settings icon at the top right corner of the template editor and select Autocompletion.

Press Ctrl + Space in the template editor to access a list of all available macros. You can narrow down the list of macros by typing in more information about what you are looking for. For example, if you are looking for a method to list the ID of the content source for a host, you can type host and check the list of available macros for content source.

A window next to the dropdown provides a description of the macro, its usage, and the value it will return.

When you find the method you are looking for, hit Enter to input the method.