CA Nimsoft Monitor. Probe Guide for Gateway. gtw v2.7 series

Transcription

1 CA Nimsoft Monitor Probe Guide for Gateway gtw v2.7 series

2 Copyright Notice This online help system (the "System") is for your informational purposes only and is subject to change or withdrawal by CA at any time. This System may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This System is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. This System may not be disclosed by you or used for any purpose other than as may be permitted in a separate agreement between you and CA governing your use of the CA software to which the System relates (the CA Software ). Such agreement is not modified in any way by the terms of this notice. Notwithstanding the foregoing, if you are a licensed user of the CA Software you may make one copy of the System for internal use by you and your employees, provided that all CA copyright notices and legends are affixed to the reproduced copy. The right to make a copy of the System is limited to the period during which the license for the CA Software remains in full force and effect. Should the license terminate for any reason, it shall be your responsibility to certify in writing to CA that all copies and partial copies of the System have been destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS SYSTEM AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SYSTEM, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The manufacturer of this System is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Legal information on third-party and public domain software used in this product is documented in the Third-Party Licenses and Terms of Use (

3 Contact CA Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback about Product Documentation Send comments or questions about CA Technologies product documentation to To provide feedback about general CA Technologies product documentation, complete our short customer survey which is available on the support website at

4

5 Contents Chapter 1: Gateway ( gtw) Overview v2.7 7 About This Guide... 7 Related Documentation... 7 Preconfiguration Requirements... 8 Supported Platforms... 8 Chapter 2: Configuration Details for Gateway ( gtw) v gtw Node... 9 Mail Server Node Profiles Node Configure a Node Manage Profiles Delete Profile Set Data File for Online Mode Chapter 3: gtw QoS Metrics 16 Contents 5

6 Documentation Changes This table describes the version history for this document. Version Date What's New? 2.7 June 2014 Updated description of Japanese Text field under the Message section of the gtw Node topic. 2.7 September 2013 Documentation on the initial web-based GUI version of this probe. (Previous versions of this probe are configured using Infrastructure Manager). 6 Probe Guide for Gateway

7 Chapter 1: Gateway ( gtw) Overview v2.7 The Gateway probe converts alarms from the CA Nimsoft Monitor NAS server into s sent to designated recipients. For Windows operating systems, you can use the SMTP protocol or the Exchange server for sending the s. For any other operating systems, you can use only the SMTP for sending s. This section contains the following topics: About This Guide (see page 7) Related Documentation (see page 7) Preconfiguration Requirements (see page 8) About This Guide This guide is for the CA Nimsoft Monitor Administrator to help understand the configuration of the Gateway probe and provides the following information: Overview of the Gateway probe and related documentation for previous probe versions. Configuration details of the probe. Field information and common procedures for configuring the probe. Related Documentation Related Documentation Documentation for other versions of the gtw probe The Release Notes for the gtw probe User documentation for the Admin Console Monitor Metrics Reference Information for CA Unified Infrastructure Management Probes ( Chapter 1: Gateway ( gtw) Overview v2.7 7

8 Preconfiguration Requirements Preconfiguration Requirements This section contains the preconfiguration requirements for the Gateway probe. For configuring the probe using IPv6 format, ensure that the following prerequisites are met: The NMS system can run the primary hub on IPv4 or IPv6 environment but the NMS must be running on IPv4 environment. For configuring the probe on a remote hub that runs the probe on IPv6 environment, follow these steps: Create a queue of type attach with subject *. Create a queue of type get to fetch data from IPv4 hub by calling the queue that is created on IPv4 hub. For configuring the probe on a remote hub that runs the probe on IPv4 and IPv6 environment, follow these steps: Create a queue of type get to fetch data from IPv6 hub by calling the queue that is created on IPv6 hub. Create a queue of type post for pushing all the data to NMS IPv4 hub. Create a queue of type post for pushing all data with Subject/Queue as an to NMS IPv6 robot. 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 Gateway probe. 8 Probe Guide for Gateway

9 Chapter 2: Configuration Details for Gateway ( gtw) v2.7 This section contains configuration details specific to the Gateway probe. The Gateway probe converts alarms into s, according to the configurations set in the CA Nimsoft Monitor Alarm Server. The probe collects these s at the specified interval and sends them to mail addresses that are defined in the profiles. In addition to configuring the Gateway probe, the NAS is configured to send alarms to the gateway. This section contains the following topics: gtw Node (see page 9) Configure a Node (see page 15) Manage Profiles (see page 15) Delete Profile (see page 15) Set Data File for Online Mode (see page 16) gtw Node In this node, you can view the probe information and can configure the general properties of the Gateway probe. You can also configure the alarm -specific settings and the backup settings. Navigation: gtw Set or modify the following values as required: gtw > Probe Information This section provides information about the probe name, probe version, start time of the probe, and the vendor who created the probe. gtw > General Configuration This section is used to configure the general properties of the Gateway probe. Log level: specifies the information that is written to the log file. Default: 0 - Fatal Chapter 2: Configuration Details for Gateway ( gtw) v2.7 9

10 gtw Node 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 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 IDs defined in the profile and the Report Recipient option is selected. Default: 300 Note: The NAS is configured to send alarms to the Gateway probe. The auto-operator in the NAS sends alarms as s when the following criteria are met: The recipient field in the auto-operator in the NAS 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 . The is sent to the recipient defined in the profile at the specified Report interval. gtw > Message This section is used to perform the alarm -specific settings. From Address: defines the address from which the alarm notification is sent to the specified recipients. Default: gtw@nimsoft.com Subject: defines the subject of the alarm notification . You can write only 100 characters in the message subject. Note: You can add a parameter subject_length in the raw configure section of the probe for increasing the length of the subject up to 998 characters. This value must be an integer, and if the length of the subject exceeds 998 characters, then the message is rejected. Message Format: specifies the formatting option for the alarm notification . Default: HTML Template: defines the format in which the s 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/ gtw directory. Default: template.html Group Recipients: sends a single group to all the recipients in the group. Default: Not selected 10 Probe Guide for Gateway

11 gtw Node on Assignment: converts assigned alarms into s and send to the specified addresses. Default: Not selected Note: If the 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 NAS probe: Set up a queue under the Queues tab. Type attach and enter the subject as , alarm_assign. These settings ensure that the Gateway probe receives and can handle all assigned alarms. Japanese Text: converts the Japanese text, present in s, into readable format. Default: Not selected Note: If the checkbox is selected, mails with Japanese text are supported and display correctly only on the Microsoft Outlook client. gtw > 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: gtw > Backup This section is used to configure the backup settings. This setting enables you to send a blind carbon copy (BCC) of all the alarm s to the specified addresses. Send Backup enables you to send backup . Default: Not selected Backup Address: defines the address to which the s are sent. Default: Disabled Chapter 2: Configuration Details for Gateway ( gtw) v2.7 11

12 gtw Node Mail Server Node This section is used to configure the mail server settings. The server type can be SMTP or Exchange. Navigation: gtw > Mail Server Set or modify the following values as required: Mail Server > Mail Server Configuration This section lets you configure the properties of the mail server. You can configure the properties of SMTP mail server as well as Exchange mail server. Server Type SMTP: specifies the primary and secondary SMTP mail server settings. Primary Mail Server: defines the main SMTP mail server that is used to send s. 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. Note: SMTP server selection does not support IPv6 format. You can create the connection using the host name. 12 Probe Guide for Gateway

13 gtw Node Exchange: specifies the properties of the Exchange mail server. Note: 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: uses the profile that is automatically created when you configure Outlook in your system. Defines the name of the preconfigured Outlook MAPI profile. Default: Selected User and server: defines the name of the exchange server to be used. Default: Not selected Username: defines the username for the exchange server authentication. Password: defines the password for the exchange server authentication. More information: Set Data File for Online Mode (see page 16) Profiles Node The Profiles node is used to define the addresses. The Gateway probe collects the alarm-converted s and forwards them to addresses defines in the profiles. Note: These s are sent from the auto-operator in the NAS probe. The s are sent at the interval that is specified in the Report Interval field of the gtw node. Navigation: gtw > Profiles Set or modify the following values as required: Profiles > Options icon > Add Profile This option lets you create a profile for specifying the address for sending the alarm-specific s. Address(es): defines the address of the recipient. Multiple addresses can be given separated by a comma. Chapter 2: Configuration Details for Gateway ( gtw) v2.7 13

14 gtw Node Report Recipients: sends an alarm report as an at regular intervals. Default: Not selected Note: The auto-operator in the NAS sends alarms as s destined for the Gateway probe when the following criteria are met. The address to be used depends on the recipient field of the auto-operator profile that is used in the NAS. The recipient field in the auto-operator in the NAS 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 . The is sent to the recipient defined in the profile at regular intervals. HTML Template: defines the template file that defines the formatting of the messages. Note: This file overrides the template that is defined in the Message Format field of the gtw > Message section. <Profile Name> Node This node lets you configure the settings of a profile. You can specify the address for sending alarm-specific s. 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: gtw > Profiles > profile name Set or modify the following values as required: profile name > Profile Configuration This section lets you configure a profile for specifying the address for sending the alarm-specific s. Note: The field descriptions are the same as described in the Profiles node. 14 Probe Guide for Gateway

15 Configure a Node Configure a Node This procedure provides the information to configure a particular section within a node. Each section within the node lets you configure the probe for converting alarms to s and send to the specified 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 s to the specified addresses. Manage Profiles You can configure the probe to create a profile for specifying the address of the receiver. You can also specify multiple addresses. You can then configure the profile to send an alarm report as an 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 at regular intervals. Delete Profile You can delete an existing profile when you no longer want the probe to send an at the specified 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. Chapter 2: Configuration Details for Gateway ( gtw) v2.7 15

16 Set Data File for Online Mode 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 tab and double-click the required in the tab. 4. Clear the Use Cached Exchange Mode check box in the Change Account dialog. The Data Files for the is now set to online mode. Chapter 3: gtw QoS Metrics The Gateway probe does not generate any QoS metrics. Therefore, there are no probe checkpoint metrics to be configured for this probe. 16 Probe Guide for Gateway