Logging IAG events to an SMTP server

  • Article

Applies To: Intelligent Application Gateway (IAG)

The Whale Communications Intelligent Application Gateway (IAG) 2007 mail reporter enables you to send e-mail messages about selected IAG events by using a Simple Mail Transfer Protocol (SMTP) server. In order to configure the mail reporter, you have to take the following steps:

  1. Enable and configure the mail reporter.

  2. Specify which messages are sent by e-mail. The mail reporter should be used to send urgent and high-priority event messages. By default (even when the mail reporter is enabled), no event messages are sent to the reporter. You must manually specify which events are sent by e-mail.

Enabling and configuring mail reporting

Enable mail reporting as follows:

To enable the mail reporter to send messages

  1. In the Configuration program, on the Admin menu, click Event Logging.

  2. On the Event Logging dialog box, click the Mail tab.

  3. Click Enable.

  4. In IP/Host, specify the IP address or host name of the SMTP server. In Port, specify the port number of the SMTP server.

  5. In From, specify the e-mail address that appears on the "From" field of the e-mail.

  6. In To, specify the e-mail address to which event logging e-mail messages should be sent.

  7. In Subject, specify the text that appears in the "Subject" field of the e-mail.

  8. In User, specify the user name required to log on to the SMTP server.

  9. In Password and Confirm Password, specify the password required for the SMTP server.

Configuring which messages are sent by the mail reporter

By default, the mail server does not send any messages to the e-mail recipients, even if this option is enabled in the Event Logging dialog box, so that the recipients are not flooded with all of the event logging messages. This procedure describes how you configure the messages that will be sent by mail.

Note

Message configuration is implemented in an XML file. In order to edit it, you need to have a working knowledge of XML technology.

To configure the messages that will be sent by mail

  1. Create a custom message definitions file, as described in Customizing IAG event messages. If such a file already exists, use the existing file.

  2. For each message that you wish to send to the SMTP server, under the <Reporters> element, add a new <Reporter> element with the value mail, as follows:

    <Reporter>mail</Reporter>

    For details of reporting elements and the full syntax of the message definitions file, see About the IAG Configuration console.

    For Example:

    To send an e-mail message each time the number of concurrent authenticated sessions that can be opened through a trunk is exceeded, access the message “Number of Max Concurrent Sessions Exceeded”, and add the Mail reporter, as shown in the example that follows. Note that, for the clarity of the example, some of the event parameters were removed from the sample code.

    <Message>

    <Id>15</Id>

    <Severity>Warning</Severity>

    <Type>Session</Type>

    <Name>AuthenticatedMaxExceeded</Name>

    <Desc>Number of Max Concurrent Sessions Exceeded</Desc>

    <DynamicDesc>VGhlIG1heGltYWwgbnVtYmVyIG9</DynamicDesc>

    <Params>

    <Param>

    <Name>MaxValue</Name>

    </Param>

    </Params>

    <Reporters>

    <Reporter>mail</Reporter>

    <Reporter>syslog</Reporter>

    <Reporter>builtin-log</Reporter>

    </Reporters>

    </Message>

  3. When you finish editing the file, on the IAG server, access the Configuration program. Click the Activate icon to activate the configuration, select the option Apply changes made to external configuration settings, and click Activate.

    Once the configuration is activated, the messages you configured here are reported to the SMTP server and sent to the specified recipients.