CA Nimsoft Monitor. Probe Guide for Microsoft Exchange Server Response Monitoring. ews_response v1.1 series

Transcription

1 CA Nimsoft Monitor Probe Guide for Microsoft Exchange Server Response Monitoring ews_response v1.1 series

2 CA Nimsoft Monitor 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 the Nimsoft Monitor solution is documented in Nimsoft Monitor 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 Nimsoft product documentation to To provide feedback about general CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at

4

5 Contents Chapter 1: Overview 7 About This Guide... 7 Related Documentation... 8 Preconfiguration Requirements... 8 Install Exchange Web Services (EWS) Java API... 8 Supported Platforms... 9 Chapter 2: Configuration Details 11 ews_response Node User-<User Name> Node Configure a Node How to Configure Alarm Thresholds Manage Users Delete User Manage Profiles Delete Profile Chapter 3: ews_response QoS Metrics 19 Contents 5

6 Documentation Changes This table describes the version history for this document. Version Date What's New? 1.1 June 2014 Added the Install Exchange Web Services (EWS) Java API topic under the Prerequisites section. 1.0 September 2013 Updated the New Features and Overview topic. Updated the document for language and style consistency. Documentation on initial web-based GUI version of this probe (Previous versions of this probe are configured using Infrastructure Manager). 6 Probe Guide for Microsoft Exchange Server Response Monitoring

7 Chapter 1: Overview The Microsoft Exchange Server Response Monitoring probe tests the performance of your Microsoft Exchange server connection by sending and receiving test s. These test s, reflects the actual end-user experience of the Exchange Server. The probe can also return mail from another instance of the probe for end-to-end monitoring. The probe measures round trip for internal and external accounts and generate QoS. You can also configure alarms when unknown mails are detected in the mailbox and the threshold value of the roundtrip time breaches. The probe supports Exchange Server 2010, 2010 SP1, 2010 SP2, and 2010 SP3. This section contains the following topics: About This Guide (see page 7) Related Documentation (see page 8) Preconfiguration Requirements (see page 8) About This Guide This guide is for the CA Nimsoft Monitor Administrator to help understand the configuration of the Microsoft Exchange Server Response Monitoring probe and provides following information: Overview of the Microsoft Exchange Server Response Monitoring probe and related documentation for previous probe versions. Configuration details of the probe. Field information and common procedures for configuring the probe. Important! Description for intuitive GUI fields is not included in the document. Chapter 1: Overview 7

8 Related Documentation Related Documentation For related information that may be of interest, see the following material: Related Documentation Documentation for other versions of the ews_response probe The Release Notes for the ews_response probe User documentation for the Admin Console Monitor Metrics Reference Information for CA Nimsoft Probes ( Preconfiguration Requirements This section contains the preconfiguration requirements for the Microsoft Exchange Server Response Monitoring probe. Install Exchange Web Services (EWS) Java API The CA Nimsoft Monitor Administrator must install EWS Java API before running the probe. The EWS Java API adds communication support for the Java client application with an Exchange Server. Follow these steps: 1. Go to the following link and download the latest EWS Java API for the probe. Note: If the given link is down, you can search with keywords code.msdn.microsoft.com: EWS Java API 1.2 on any search engine. 2. Unzip the downloaded zip file and find the file with name EWSJavaAPI_1.2.jar in the unzipped folder. 3. Copy the EWSJavaAPI_1.2.jar file to the following path. Nimsoft_Installation_Directory\Nimsoft\probes\application\ews_response\lib 4. Restart the probe. EWS Java API is installed. Note: EWS Java API is required for monitoring Exchange Server from 1.10 version of the probe. 8 Probe Guide for Microsoft Exchange Server Response Monitoring

9 Preconfiguration Requirements Supported Platforms New Features Refer to the Nimsoft Compatibility Support Matrix for the latest information about supported platforms. See also the Support Matrix for Nimsoft Probes for specific information about the Microsoft Exchange Server Response Monitoring probe. The probe supports Exchange Server 2010 SP2 and 2010 SP3. Chapter 1: Overview 9

10

11 Chapter 2: Configuration Details The Microsoft Exchange Server Response Monitoring probe is configured for monitoring the Exchange Server by defining one or more users. You can add profiles for each user. These monitoring profiles define how the test mail message is sent and returned. These profiles also specify the alarm and QoS properties. This section contains the following topics: ews_response Node (see page 11) Configure a Node (see page 16) How to Configure Alarm Thresholds (see page 16) Manage Users (see page 16) Delete User (see page 17) Manage Profiles (see page 17) Delete Profile (see page 17) ews_response Node This section contains the configuration details specific to the Microsoft Exchange Server Response Monitoring probe. In this node, you can view the probe information and can configure the setup properties. Navigation: ews_response Set or modify the following values as required. ews_response > Probe Information This section provides information about the probe name, probe version, start time of the probe, and the probe vendor. ews_response > General Configuration This section lets you configure the properties of the Microsoft Exchange Server Response Monitoring. Log Level: specifies the level of details that are written to the log file. Default: 0 - Fatal Check Every Second: specifies how often the inbox is read. The inbox is only read when there are outstanding mail messages. Default: 15 Note: The probe deletes the mail after scanning the inbox of the user to save inbox storage space. Chapter 2: Configuration Details 11

12 ews_response Node Bounce Nimsoft Test Mail from other sources back to Sender: enables the Exchange client response to return incoming test mail to the sender. Default: Not Selected Stop reading inbox when other than Nimsoft Test Mails Found: specifies the number of messages, which are scanned. Default: 30 ews_response > Send Alarm on Unexpected Mail This section lets you generate alarms if other mail messages appear. If the test user is an active user, there are other mail messages in the inbox. ews_response > Message Pool This section lets you generate alarm to view a particular alarm message detail. Message Name: identifies the unique name of the message. This name is used to refer to the message from the profiles. Text: identifies the alarm message text. Use following variables for including run-time information in the alarm message text: profile mail_to used threshold diff Level: identifies the alarm message severity. Default for: identifies the default message name. i18n Token: identifies the predefined alarms fetched from the database. ews_response > Options Icon > Add New User This section lets you add a user with a valid user name, password, and the name of the Exchange server to log in. Active: activates or deactivates the user. Exchange Version: specifies the version of the Exchange Server. 12 Probe Guide for Microsoft Exchange Server Response Monitoring

13 ews_response Node User-<User Name> Node <Server Name> Node <User Name> Node This node lets you configure the user information. Note: The user name is user-configurable and is referred to as user-user name in this document. Navigation: ews_response > User-user name Set or modify the following values that are based on your requirement: User Info This section lets you configure the user information. This node represents the server name of the profile that is used to monitor the performance of the Exchange server. Note: The server name is user-configurable and is referred to as server name in this document. This node lets you edit the properties of the user and configure the advanced inbox settings. Note: The user name is user-configurable and is referred to as user name in this document. Navigation: ews_response > User-user name > server name > user name Set or modify the following values that are based on your requirement: user name > User Properties This section lets you edit the properties of the user, such as the name, password, and exchange server to log in. Chapter 2: Configuration Details 13

14 ews_response Node user name > Advanced Inbox Settings This section lets you set the advanced inbox settings parameters, such as inbox check time, inbox send alarm, and advanced inbox alarms. Inbox Check Time: specifies how often the probe checks the inbox of the user mail box is checked. Default: Use Global Check Every Second: specifies the number of times the probe checks the inbox in one second. Default: 0 Bounce Nimsoft Test Mail from other sources back to Sender: returns the incoming mail to the sender. Default: Selected Inbox Send Alarm: specifies the condition to generate an alarm. Send Alarm on Unexpected Mail: generates alarm if other mail messages appear. Default: Not Selected Advanced Inbox Mails: scans specified mails other than Nimsoft mails. Stop Reading Inbox when other than Nimsoft Mails Found: specifies the number of mails other than Nimsoft mails. Default: 0 <Profile Name> Node user name > Options Icon > Add New Profile This section lets you add a monitoring profile, which is defined for a user. You can configure the properties of profiles using this node. You can also specify the alarm and QoS properties. Note: The profile name is user-configurable and is referred to as the profile name in this document. Navigation: ews_response > User-user name > server name > user name > profile name Set or modify the following values that are based on your requirement: profile name > Profile General Parameters This section lets you configure the general properties of the profile. Name: defines the name of the profile. Active: activates or deactivates the profile. Default: Selected 14 Probe Guide for Microsoft Exchange Server Response Monitoring

15 ews_response Node Mail to: defines the target address where the is directed. Default: <self> profile name > Quality of Service Messages on Mail Sent Time This section lets you configure the alarm and QoS when an is sent. Send mail every second: specifies the interval after which an is sent. Default: 300 profile name > Quality of Service Messages on Mail RTT This section lets you configure the alarm and QoS on roundtrip time. Send Alarm: generates alarm if mail roundtrip time exceeds the specified threshold. Default: Not Selected Roundtrip Time Threshold (Seconds): specifies the mail roundtrip time. Default: 120 Note: If the mail is received after Consider Mail Lost after Seconds, the QoS message for Roundtrip Time Threshold is null. Using Alarm Message: specifies the alarm message when the mail roundtrip time exceeds the threshold. Default: MailTimeout Mail Error Message: specifies the alarm message when unable to send mail to the specified user. Default: Mailerror Consider Mail Lost after Seconds: specifies the time (in seconds) before the mail is considered as lost. Default: 300 Lost Mail Message: specifies the alarm message to be used when the mail is not delivered. Default: MailLost Accept undelivered Reply as OK: changes the status of undelivered s as delivered. Default: Selected Chapter 2: Configuration Details 15

16 Configure a Node Configure a Node This procedure provides information to configure a particular section within a node. Each section within the node lets you configure the properties of the probe for monitoring Microsoft Exchange Server performance. 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 monitor the Microsoft Exchange Server. How to Configure Alarm Thresholds Some Quality of Service measurement probes allow you to set different types of alarm thresholds. These threshold options allow you to more broadly control when alarm messages are sent for each QoS probe. For more information about the different alarm thresholds and their configuration requirements, refer to the General Probe Configuration section of the Admin Console Help. Important! Alarm threshold settings are dependent on the baseline_engine probe. If you do not have the correct version of baseline_engine configured, you will not see the additional threshold options. Manage Users The Server Administrator must add and manage users for monitoring the Exchange Server. Follow these steps: 1. Click the Options icon next to the ews_response node in the navigation pane. 2. Click the Add New User option. 3. Update the field information and click Submit. The user is created under the ews_response node. 16 Probe Guide for Microsoft Exchange Server Response Monitoring

17 Delete User Delete User You can delete an existing user when you no longer want it. Follow these steps: 1. Click the Options icon next to the User-user name node that you want to delete. 2. Click the Delete User option. The user is deleted. Manage Profiles The Server Administrator must create and configure monitoring profiles for monitoring the Exchange Server. Follow these steps: 1. Click the Options icon next to the ews_response node in the navigation pane. 2. Click the Add New Profile option. 3. Update the field information and click Submit. The new profile is created under the user name node. Using the profile, you can define how the test mail message is sent and returned and also specify the alarm and QoS properties. Delete Profile You can delete an existing profile when you no longer want it. 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 17

18

19 Chapter 3: ews_response QoS Metrics This section contains the QoS metrics for the Microsoft Exchange Server Response Monitoring probe. Monitor Name Units Description QOS_Exchange_Mail_Send Milliseconds Mail sent time in milliseconds. QOS_Exchange_Mail_Roundtrip Seconds Mail turnaround time in seconds. Chapter 3: ews_response QoS Metrics 19