Chapter 6. Configuring Email Notifications

You can configure Satellite to send email messages to individual users registered to Satellite. Satellite sends the email to the email address that has beed added to the account, if present. Users can edit the email address by clicking on their name in the top-right of the Satellite web UI and selecting My account.

Configure email notifications for a user from the Satellite web UI.

Procedure

  1. Navigate to Administer > Users.
  2. Click the Username of the user you want to edit.
  3. On the User tab, verify the value of the Mail field. Email notifications will be sent to the address in this field.
  4. On the Email Preferences tab, select Mail Enabled.
  5. Select the notifications you want the user to receive using the drop-down menus next to the notification types.

    Note

    The Audit Summary notification can be filtered by entering the required query in the Mail Query text box.

  6. Click Submit.

    The user will start receiving the notification emails.

6.1. Testing Email Delivery

To verify the delivery of emails, send a test email to a user. If the email gets delivered, the settings are correct.

Procedure

  1. In the Satellite web UI, navigate to Administer > Users.
  2. Click on the username.
  3. On the Email Preferences tab, click Test email.

    A test email message is sent immediately to the user’s email address.

If the email is delivered, the verification is complete. Otherwise, you must perform the following diagnostic steps:

  1. Verify the user’s email address.
  2. Verify Satellite Server’s email configuration.
  3. Examine firewall and mail server logs.

6.2. Testing Email Notifications

To verify that users are correctly subscribed to notifications, trigger the notifications manually.

Procedure

  • To trigger the notifications, execute the following command:

    # foreman-rake reports:<frequency>

    Replace frequency with one of the following:

  • daily
  • weekly
  • monthly

This triggers all notifications scheduled for the specified frequency for all the subscribed users. If every subscribed user receives the notifications, the verification succeeds.

Note

Sending manually triggered notifications to individual users is currently not supported.

6.3. Notification Types

The following are the notifications created by Satellite:

  • Audit summary: A summary of all activity audited by Satellite Server.
  • Host built: A notification sent when a host is built.
  • Host errata advisory: A summary of applicable and installable errata for hosts managed by the user.
  • OpenSCAP policy summary: A summary of OpenSCAP policy reports and their results.
  • Promote errata: A notification sent only after a Content View promotion. It contains a summary of errata applicable and installable to hosts registered to the promoted Content View. This allows a user to monitor what updates have been applied to which hosts.
  • Puppet error state: A notification sent after a host reports an error related to Puppet.
  • Puppet summary: A summary of Puppet reports.
  • Sync errata: A notification sent only after synchronizing a repository. It contains a summary of new errata introduced by the synchronization.

6.4. Changing email notification settings for a host

Satellite can send event notifications for a host to the host’s registered owner.

You can configure Satellite to send email notifications either to an individual user or a user group. When set to a user group, all group members who are subscribed to the email type receive a message.

To view the notification status for a host, navigate to Hosts > All Hosts and click the host you want to view. In the host details page, click the Additional Information tab, you can view the email notification status.

Receiving email notifications for a host can be useful, but also overwhelming if you are expecting to receive frequent errors, for example, because of a known issue or error you are working around.

To change the email notification settings for a host, complete the following steps.

Procedure

  1. In the Satellite web UI, navigate to Hosts > All Hosts, and select the host with the notification setting you want to change.
  2. Select the host’s check box, and from the Select Action list, select Enable Notifications or Disable Notifcations, depending on what you want.