CA Nimsoft Monitor Snap Configuration Guide for Email Gateway emailgtw v2.7 series
Legal Notices Copyright 2013, CA. All rights reserved. Warranty The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Nimsoft LLC disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Nimsoft LLC shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Nimsoft LLC and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control. Technology Licenses The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license. No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Nimsoft LLC as governed by United States and international copyright laws. Restricted Rights Legend If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft LLC s standard commercial license terms, and non-dod Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data. Trademarks Nimsoft is a trademark of CA. Adobe, Acrobat, Acrobat Reader, and Acrobat Exchange are registered trademarks of Adobe Systems Incorporated. Intel and Pentium are U.S. registered trademarks of Intel Corporation. Java(TM) is a U.S. trademark of Sun Microsystems, Inc. Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation. Netscape(TM) is a U.S. trademark of Netscape Communications Corporation. Oracle is a U.S. registered trademark of Oracle Corporation, Redwood City, California. UNIX is a registered trademark of the Open Group. ITIL is a Registered Trade Mark of the Office of Government Commerce in the United Kingdom and other countries. All other trademarks, trade names, service marks and logos referenced herein belong to their respective companies. For information on licensed and public domain software, see the Nimsoft Monitor Third-Party Licenses and Terms of Use document at: http://docs.nimsoft.com/prodhelp/en_us/library/index.htm?toc.htm?1981724.html.
Contents Chapter 1: Overview 5 About This Guide... 5 Related Documentation... 5 Preconfiguration Requirements... 5 Supported Platforms... 6 Chapter 2: Configuration Details 7 emailgtw Node... 7 Mail Server Node... 9 Profiles Node... 11 Configure a Node... 12 Manage Profiles... 13 Delete Profile... 13 Set Data File for Online Mode... 13 Chapter 3: emailgtw QoS Metrics 15 Contents 3
Documentation Changes This table describes the version history for this document. Version Date What's New? 2.7 September 2013 Initial web-based GUI version of this probe. (Previous versions of this probe are configured using Infrastructure Manager). 4 Configuration Guide for Email Gateway
Chapter 1: Overview The Email Gateway probe converts alarms into emails and the user receives messages as emails. The Nimsoft Alarm Server can be set up to send alarms to the Email Gateway probe. For the Windows operating system, you can use the SMTP protocol or the Exchange server for sending the emails. For any other operating system, you can use only the SMTP server for sending emails. This section contains the following topics: About This Guide (see page 5) Related Documentation (see page 5) Preconfiguration Requirements (see page 5) About This Guide This guide is for the CA Nimsoft Monitor Snap Administrator to help understand the configuration of the Email Gateway probe. This guide contains the following information: An overview of the Email Gateway probe. The related documentation for previous probe versions, release notes, and so on. The configuration details of the probe including information for the fields that are required to configure the probe. The common procedures that can be used in the probe configuration. Important! The field description for intuitive terms in the GUI has not been included in the document. Related Documentation For related information that may be of interest, see the following material: Related Documentation The Release Notes for the emailgtw probe (Email Gateway) Preconfiguration Requirements This section contains the preconfiguration requirements for the Email Gateway probe. Chapter 1: Overview 5
Preconfiguration Requirements Supported Platforms Refer to the Nimsoft Compatibility Support Matrix for the latest information on supported platforms. See also the Support Matrix for Nimsoft Probes for specific information on the Email Gateway probe. 6 Configuration Guide for Email Gateway
Chapter 2: Configuration Details This section contains configuration details specific to the Email Gateway probe. The Email Gateway probe converts alarms into emails, according to the configurations set in the Nimsoft Alarm Server. The probe collects these emails at the specified interval and sends them to mail addresses that are defined in the profiles. In addition to configuring the Email Gateway probe, the Nimsoft Alarm Server is configured to send alarms to the email gateway. This section contains the following topics: emailgtw Node (see page 7) Configure a Node (see page 12) Manage Profiles (see page 13) Delete Profile (see page 13) Set Data File for Online Mode (see page 13) emailgtw Node In this node, you can view the probe information and can configure the general properties of the Email Gateway probe. You can also configure the alarm email-specific settings and the backup email settings. Navigation: emailgtw Set or modify the following values that are based on your requirement: emailgtw > Probe Information This section provides information about the probe name, probe version, start time of the probe, and the vendor who created the probe. emailgtw > General Configuration This section is used to configure the general properties of the Email Gateway probe. Log level: Specifies the information that is written to the log file. Default: 0 - Fatal Log size: Specifies the size of the probe log file to which the internal log messages of the probe are written. When this size is reached, new log file entries are added and the older entries are deleted. Default: 100 Chapter 2: Configuration Details 7
emailgtw Node Report Interval: Specifies the interval in which the probe checks whether an alarm report file exists. If a file is found, it is sent to the recipient email IDs defined in the profile and the Report Recipient option is selected. Default: 300 Note: The Nimsoft Alarm Server is configured to send alarms to the Email Gateway probe. The auto-operator in the Nimsoft Alarm Server sends alarms as emails when the following criteria are met: The recipient field in the auto-operator in the Nimsoft Alarm Server is kept blank. The Report Recipient option is selected for the profile. When these conditions are met, a report containing all alarms matching the criteria is sent as an email. The email is sent to the recipient defined in the profile at the specified Report interval. emailgtw > Email Message This section is used to perform the alarm email-specific settings. From Address: Defines the email address from which the alarm notification is sent to the specified recipients. Default: emailgtw@nimsoft.com Message Format: Specifies the formatting option for the alarm notification email. Default: HTML Template: Defines the format in which the emails are formatted. If HTML is selected in the Message Format field, the template is template.html. If Text is selected, the template is changed to the text version (template.txt). These files (.html or.txt) are located in the Nimsoft/Probes/gateways/emailgtw directory. Default: template.html Group Recipients: Sends a single group email to all the recipients in the group. Default: Not selected Email on Assignment: Converts assigned alarms into emails and send to the specified email addresses. Default: Not selected Note: If the Email Gateway probe for some reason is unavailable, it cannot handle alarms for that period. To avoid this situation, you can set the following features on the Nimsoft Alarm Server probe: Set up a queue under the Queues tab. Type attach and enter the subject as EMAIL, alarm_assign. These settings ensure that the Email Gateway receives and can handle all assigned alarms. 8 Configuration Guide for Email Gateway
emailgtw Node Japanese Text: Converts the Japanese text, present in emails, into readable format. Default: Not selected emailgtw > Alarm Settings This section is used to configure the alarm settings for situations where the mail server is not accessible. Send Alarm: Sends an alarm if there is a failure in accessing the mail server. Default: Selected Subsystem: Defines the subsystem originating the alarm. Default: 1.1.12 emailgtw > Backup Email This section is used to configure the backup email settings. This setting enables you to send a blind carbon copy (BCC) of all the alarm emails to the specified addresses. Send Backup Email: Enables you to send backup email. Default: Not selected Backup Email Address: Defines the email address to which the emails are sent. Default: Disabled Mail Server Node This section is used to configure the mail server settings. The server type can be SMTP or Exchange. Navigation: emailgtw > Mail Server Set or modify the following values that are based on your requirement: Mail Server > Mail Server Configuration This section allows you to select between the SMTP or the Exchange server for sending the alarm-specific emails. Server Type: Allows you to select between the SMTP or Exchange server options. Mail Server > Server Type (SMTP) This section is used to configure the primary and secondary SMTP mail server settings. Chapter 2: Configuration Details 9
emailgtw Node Primary Mail Server: Defines the main SMTP mail server that is used to send emails. If you wish to specify a non-default port number for the smtp service on the mail server, append ":<portnumber>" after the mail server hostname or IP address. Example: smtp.yourserver.com:26 Ignore TLS: Specifies that the Transport Layer Security (TLS) negotiation is not attempted even if the server is competent. This feature is required because some servers announce TLS capability even if it is not present, due to a missing certificate. Default: Not selected Username: Defines the username for the SMTP server authentication. Password: Defines the password for the SMTP server authentication. Secondary Mail Server: Defines the secondary mail server to be used when the primary server fails. If you wish to specify a non-default port number for the smtp service on the mail server, append ":<portnumber>" after the mail server hostname or IP address. Example: smtp.yourserver.com:26 Mail Server > Server Type (Exchange) This section is used to configure the exchange server settings. You can either provide the preconfigured profile or use some other server and user credentials. To enable and run the probe using the Exchange server, create a MAPI profile. Make sure that a test user exists in the Exchange server before you configure the probe settings. In the Outlook settings, the data file is set in online mode (refer Set Data File for Online Mode section). Pre-configured profile: Allows you to use the profile that is automatically created when you configure Outlook in your system. Defines the name of the preconfigured Outlook MAPI profile. Default: Selected Note: This profile is already created and configured in Outlook before entering the name here. You can find the profile name in the Control Panel > All Control Panel Items > Mail dialog box. User and server: Defines the name of the exchange server to be used. Default: Not selected Note: This option allows you to use some other server and user credentials. Username: Defines the username for the exchange server authentication. Password: Defines the password for the exchange server authentication. 10 Configuration Guide for Email Gateway
emailgtw Node Mail Server > Actions > Test Server Settings This button in the Actions drop-down list allows you to verify that the mail server responds. More information: Set Data File for Online Mode (see page 13) Profiles Node The Profiles node is used to define the email addresses. The Email Gateway probe collects the alarm-converted emails and forwards them to email addresses defines in the profiles. Note: These emails are sent from the auto-operator in the Nimsoft Alarm Server probe. The emails are sent at the interval that is specified in the Report Interval field of the emailgtw node. Navigation: emailgtw > Profiles Set or modify the following values that are based on your requirement: Profiles > Options icon > Add Profile This option allows you to create a profile for specifying the email address for sending the alarm-specific emails. Email Address(es): Defines the email address of the recipient. Multiple email addresses can be given separated by a comma. Report Recipients: Sends an alarm report as an email at regular intervals. Default: Not selected Note: The auto-operator in the Nimsoft Alarm server sends alarms as emails destined for the Email Gateway probe when the following criteria are met. The email address to be used depends on the recipient field of the auto-operator profile that is used in the Nimsoft Alarm Server. The recipient field in the auto-operator in the Nimsoft Alarm Server is kept blank. The Report Recipient option is selected for the profile. When these conditions are met, a report containing all alarms matching the criteria is sent as an email. The email is sent to the recipient defined in the profile at regular intervals. Chapter 2: Configuration Details 11
Configure a Node HTML Template: Defines the template file that defines the formatting of the email messages. Note: This file overrides the template that is defined in the Message Format field of the emailgtw > Email Message section. <Profile Name> Node This node allows you to configure the settings of a profile. You can specify the email address for sending alarm-specific emails. Note: All the profiles, appearing as child nodes, under the Profiles node are user-configurable. Hence, these profiles are referred as the profile name throughout this document. Navigation: emailgtw > Profiles > profile name Set or modify the following values that are based on your requirement: profile name > Profile Configuration This section allows you to configure a profile for specifying the email address for sending the alarm-specific emails. Note: The field descriptions are the same as described in the Profiles node. Configure a Node This procedure provides the information to configure a particular section within a node. Each section within the node allows you to configure the probe for converting alarms to emails and send to the specified email addresses. Follow these steps: 1. Select the appropriate navigation path. 2. Update the field information and click Save. The specified section of the probe is configured. The probe is now ready to send to the alarm-related emails to the specified email addresses. 12 Configuration Guide for Email Gateway
Manage Profiles Manage Profiles You can configure the probe to create a profile for specifying the email address of the receiver. You can also specify multiple email addresses. You can then configure the profile to send an alarm report as an email at regular intervals. Follow these steps: 1. Click the Options icon next to the Profiles node in the navigation pane. 2. Click the Add Profile option. 3. Update the field information and click Submit. The profile is saved and you can configure the profile properties for sending an alarm report as an email at regular intervals. Delete Profile You can delete an existing profile when you no longer want the probe to send an email at the specified email address. Follow these steps: 1. Click the Options icon next to the profile name node that you want to delete. 2. Click the Delete Profile option. The profile is deleted. Set Data File for Online Mode To enable and run the probe using the Exchange server, the data file is set in online mode in the Outlook settings. Follow these steps: 1. Open Microsoft Outlook. 2. Select Tool > Account Settings. 3. Click the E-mail tab and double-click the required email in the tab. 4. Clear the Use Cached Exchange Mode check box in the Change E-mail Account dialog. The Data Files for the email is now set to online mode. Chapter 2: Configuration Details 13
Chapter 3: emailgtw QoS Metrics The emailgtw probe does not generate any QoS metrics. Therefore, there are no probe checkpoint metrics to be configured for this probe. Chapter 3: emailgtw QoS Metrics 15