Skip to content
CA Unified Infrastructure Management Probes
Documentation powered by DocOps

emailgtw IM Configuration

Last update November 21, 2018

The Email Gateway (emailgtw) probe converts alarms into emails according to the configurations defined in the Alarm Server (nas).  You can create profiles to generate email notifications when a problem in the system requires action. The probe can also collect alarms within a specified interval and sends them to the email addresses defined in the profiles. The emails are sent based on predefined criteria for alarms, such as, severity, origin, and time.

The following diagram outlines the process to configure the probe to send emails for alarms.

Configuring emailgtw IM


Verify Prerequisites

  • Verify that required hardware, and software information is available before you configure the probe. For more information, see emailgtw (Email Gateway) Release Notes.
  • Ensure that you understood the probe and how SMTP server failover affects the probe performance. For more information, see emailgtw (Email Gateway).

Configure General Properties

You can configure the general properties of the probe to specify the log and report interval details, backup properties, and format of the email. The probe uses these details to send emails when NAS generates alarms. You can also define the alarm settings when the email server becomes inaccessible.

Follow these steps:

  1. Open the Properties dialog from the toolbar and specify the following field values.
    • Log-level: specifies the level of information that is written in the log file.
      Default: Less

      Note: Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.

    • Log size: specifies the maximum size of the probe log file in kilobytes. When this size is reached, new log file entries are added and the older entries are deleted.
      Default: 100 Kb 
    • Report Interval: specifies the interval after which the probe checks whether an alarm report file exists. If a file is found and the Report Recipient option is selected in the profile, it is sent to the recipients defined in the profile.
      Default: 300

      Note: Reduce this interval to generate alarms frequently. A shorter interval can also increase the system load.

    • Email on Assignment: converts assigned alarms into emails and sends to the email addresses defined in the profiles.
      Default: Not selected

      Note: For some reason, if the emailgtw probe is not available, it cannot receive and handle the assigned alarms. To avoid missing these alarms during this duration, perform the following tasks on the hub probe:
      1. Set up a queue under the Queues tab.
      2. Type attach and enter the subject as EMAIL, alarm_assign.

      If the emailgtw probe and the hub probe are on different robots, the attach queue must be created on the hub of the primary robot.

    • (Optional) Use HTML Format: allows you to specify HTML format for the emails that are sent. If you do not select this option, the emails are formatted in the .txt format.
      Default: Selected
    • (Optional) Group Recipients: sends a single group email to all the recipients in the group.
      Default: Not selected
  2. Specify the following field values of the emails:

    • From: specifies the email address from where the probe sends the email.
    • Subject: specifies the subject of the alarm notification emails. You can only enter 100 characters in the subject. Press '$' key to select from a list of available variables. For more information about the list of variables, see Variable Expansion in the emailgtw Advanced Configuration .

      Note: To increase the subject length, you can add a subject_length parameter in the raw configure section of the probe. The value must be an integer and the length can only be increased up to 998 characters. If the subject length exceeds 998 characters, then the message is rejected.

    • Template: specifies the format in which the email messages are formatted - either the template.html file or the template.txt file. These files are located in the <CA UIM Installation Directory>/Probes/gateways/emailgtw directory.
      This template is the default template for all profiles unless another template is specified in the Profile properties dialog. You can create a new template or edit the existing template. For more information, see the Create or Edit a Template section.
  3. (Optional) Select Backup Email Settings to send a blind carbon copy (BCC) of all the alarm emails to the specified Backup Email Address. This functionality enables you to monitor the emails that are sent by the probe.
    Default: Not selected
  4. (Optional) Select Alarm Settings to configure the following settings for situations where the email server is inaccessible:
    • Subsystem: defines the subsystem originating the alarm. 
      Default: 1.1.12, which translates to Mail in the Subsystems section of the nas probe.
    • Severity: defines the severity level of the alarm.
      Default: major 
  5. (Optional) Select the Locale to specify the language encoding of the CA UIM alarms to be displayed correctly in emails. The probe supports Japanese(ISO-2022-JP) and Japanese(Shift_JIS), Simplified Chinese, and Traditional Chinese. The emails in these languages are displayed correctly on the Microsoft Outlook client only
    Default: None 

Manage Server Credentials

Configure the probe by providing the server details with the user name and password. The probe uses these credentials to access server and send emails. The emailgtw probe supports SMTP and Exchange servers to send emails on a Windows robot. However, you can configure only one server in the probe at a time. For robots on other operating systems, you can only use the SMTP server.

Configure SMTP Server

Use this procedure if you want to use an SMTP server to send emails. You can also configure the probe with Office365 using SMTP Server.

Follow these steps:

  1. Open the Properties dialog.
  2. Select SMTP in the Server Selection box.
  3. Navigate to the SMTP tab and specify the following email server details.
    • Primary Mail Server: defines the main SMTP server that is used to send emails. Append ":<portnumber>" after the hostname or IP address if you want to specify a non-default port number for the SMTP server. 
      • Username and Password: specifies the login credentials for the SMTP server authentication.
      • Test button: allows you to verify the email server response. A green indicator means OK and a red indicator indicates that the server did not respond.
    • Secondary Mail Server: defines the secondary SMTP server to be used when the primary SMTP server fails. 
  4. (Optional) Select Ignore TLS if you do not want the probe to attempt a Transport Layer Security (TLS) connection with the primary and secondary email server. This feature is required because some email servers announce TLS capability even if it is not present, due to a missing certificate.

    Note: The Linux robot where the probe is deployed must have OpenSSL certificate installed to use the TLS functionality to connect to the SMTP server.

  5. Click the Test button to verify the email server response.

Configure Exchange Server

You can use an Exchange server on a Windows robot to send emails. You can create a MAPI profile to enable and run the probe using the Exchange server. A test user must already exist in the Exchange server before you configure the probe. The data file must be in online mode in the Outlook settings. For more information, see Set Outlook Data File for Online Mode section in the emailgtw Advanced Configuration

You can use either of the following options:

  • Pre-configured profile: Use this option when you want to use the profile that is created with the Outlook configuration on your system.
  • User and Server: Use this option when you want to use some other user credentials.

Note: You cannot configure the probe with Office365 using Exchange Server.

Follow these steps:

  1. Open the Properties dialog.
  2. Select Exchange in the Server Selection box.
  3. Navigate to the Exchange tab.
  4. Select either Pre-configured profile or User and server option.
  5.  Specify the following details of the selected configuration:
    • Profile Name or Server name:
      • Define the pre-configured Outlook profile name if you select Pre-configured profile.

        Note: This profile must exist and configured in Outlook before using in the probe. To find the profile name, navigate to the Control Panel > Mail dialog.

      • Define the name of the Exchange server if you select User and server.
    • Domain Name: name of the Exchange server domain
    • Name: a valid user name of the Exchange server.
    • Password: a valid password for the specified user.
  6. Click the Test button to verify the email server response. A green indicator means OK and a red indicator indicates that the server did not respond.

When the probe starts, the probe connects to the defined Exchange server with the provided user credentials. These MAPI profiles are ALWAYS removed when the probe stops or deactivates.

Create a Profile

Create one or more profiles to define the recipients. The probe sends the alarm converted emails to the email addresses defined in the profiles, at the specified interval.

Follow these steps:

  1. Click the Add profile button in the toolbar.
    The Add Profile dialog displays. 
  2. Specify the following field values:
    • Name: name of the profile.
    • Email: defines the email address of the recipient. You can specify multiple recipients, separated with a comma, if the Group Recipients option is selected in the Properties > General tab. If there are multiple recipients in a profile, each email is sent to all recipients in the To field.

      Note: For Exchange server, the probe supports more than 1024 characters if Group Recipients check box is selected in the Email Message section. However, for SMTP server, the probe supports up to 1024 characters.

    • Subject: specifies the subject of the emails. The subject defined here overrides the Subject defined in the Properties > General tab. Press '$' key to select from a list of available variables. For more information about the list of variables, see Variable Expansion in the emailgtw Advanced Configuration.

    • Report recipient: sends the alarm report as an email at regular intervals, as defined in the Report Interval field in emailgtw node.
      Default: Not selected

      Note: The auto-operator in the NAS sends a report email from the emailgtw probe containing all alarms when the following conditions are met. The email is sent to the recipient defined in the profile at the specified Report interval.

      • The recipient field in the auto-operator in the NAS is blank.
      • The Report Recipient option is selected for the profile.
    • HTML Template: specifies the template file that defines the email format. The template defined here overrides the Template defined in the Properties > General tab. 

Create or Edit a Template

You can define the email format and save it as a template on your local drive. The default location for the template is <CA UIM Installation Directory>/Probes/Gateways/emailgtw. The template can either be created from the General tab in the Properties dialog or the Add Profiles dialog.

Follow these steps:

  1. Open the Properties dialog.
  2. Define a unique name in the Template field with either .html or .txt extension.
  3. Click Edit.
    A warning informs that the file does not exist. 
  4. Click OK.
    An empty file launches in an editor. 
  5. Create the template and exit the editor. Press '$' key to select from a list of available variables. For more information about the list of variables, see Variable Expansion in the emailgtw Advanced Configuration.
  6. Similarly, specify an existing template name in the Template field to edit it.
Was this helpful?

Please log in to post comments.