Chat now with support
Chat with Support

Unified Communications Diagnostics 8.6.3 - User Guide

About Unified Communications Diagnostics Getting Started Using the Management Console Introducing Management Console health tests Health tests available from the Exchange organization node
About the Exchange-based health tests Exchange Server Health Test Prerequisites for Exchange Delivery Health Tests Exchange Internal Server Delivery Health Test Exchange Internal Mailbox Delivery Health Test Exchange External Message Delivery Health Test Exchange Modern Message Delivery Health Test Exchange Storage Health Test Exchange Queue Health Test Internal Outlook Web Access (OWA) Availability Health Test External Outlook Web Access (OWA) Availability Health Test Exchange Replication Health Test Exchange System Health Test Active Directory Account Lockout Health Test Exchange Online Connectivity Health Test Exchange Online Mailbox Logon Health Test Exchange Online Message Delivery Health Test Office 365 Subscription Health Test BlackBerry Server Health Test BlackBerry Message Delivery Health Test Creating test mailboxes for Exchange Adding health sets for Exchange System health tests Configuring Exchange impersonation for the Modern Message Delivery health test Registering UC Diagnostics with the Microsoft Azure portal
Health tests available from the Lync/Skype for Business Environment Resolving Problems with Native Tools Launching the Diagnostic Console from the Management Console Launching UC Analytics from the Management Console Diagnosing Problems using the Diagnostic Console UC Diagnostics: Exchange 2007 Diagnostic Console (Plug In) UC Diagnostics: Exchange 2010 Diagnostic Console (Plug In) UC Diagnostics: Exchange 2013 Diagnostic Console (Plug In) UC Diagnostics: Exchange 2016 Diagnostic Console (Plug In) UC Diagnostics: BlackBerry Diagnostic Console (Plug In) UC Diagnostics: OCS Diagnostic Console (Plug In) UC Diagnostics: Lync 2013 or Skype for Business 2015 Diagnostic Console (Plug In) Reporting Using Web Reports Counters with Non-Zero Alarm Values

Specifying the test configuration

When scheduling health tests, you must provide details about the following settings:

•
Configuring the execution schedule
•
Configuring notification settings
•
Adding notification recipients
•
Adding notification groups
•
Configuring alternate credentials
•
Managing database settings

Configuring the execution schedule

Use the Execution schedule panel to set up the frequency and the time frames during which you want the tests to run. The following options are available in the Execution Schedule panel:

 
Table 2. Scheduling options.
Option
Description

Run once

Select this to run the test immediately, and on demand.

Run every (minutes)

Select this to enter the time interval in minutes after which the next test starts.

NOTE: If a test is scheduled to run every ten minutes (for example 12:00), but a test iteration takes 15 minutes, the test skips the next iteration (that is, 12:10), and the next iteration does not run until the next scheduled time (that is 12:20).

Use execution window

Select this check box to only run within a specific time window. You must specify a Start time and End time for the Test Execution Schedule.

Run every day at

Select this to schedule the test to run once daily at this specific time.

For information on setting notifications and credentials, Configuring notification settings and Configuring alternate credentials respectively.

To run the test now
•
Expand the Tests node in the Management Console treeview, right-click the test you want and select Run Now.

You can use the Run Now option on scheduled or unscheduled tests.

Configuring notification settings

Use the Notification Settings panel to select the group that is notified when the server counter values exceed the configured threshold. You can configure notification settings to alert users about errors only or about both errors and warnings. To save time, configure the global settings before you configure individual tests.

When you specify the SMTP server to be used for notifications, you can use the default values of port 25 and anonymous authentication or you can specify any or all of the following options:

•
enter a custom port number
•
specify that STARTTLS protocol be used
•
use specific credentials for SMTP server authentication

You can create notification groups to allow specified groups to receive messages about alarms, warnings, or errors on a per counter basis. You can send notifications only to groups, not to individual users.

Use the Add Recipients dialog box to specify the members of each group. You can include the same recipients across notification groups.

You can specify the following notification parameters:

•
whether you want the emails in HTML or Plain Text format
•
the level of severity at which you want to receive email messages
•
an arbitrary command line executable to be run
Adding notification recipients
To create recipients to receive notifications
1
If you are in the process of creating a test, click Manage Notifications in the Test Settings page.
- OR -
Expand the Global Settings node in the Management Console treeview and select Notifications.
2
Enter the name of an SMTP server in the Primary SMTP Server field.
a
If you need to specify a custom port for the SMTP server, enter the number in the Port field.
By default, port 25 is used.
b
If you need to use STARTTLS protocol, select the check box beside Use STARTTLS.
3
Optionally, enter the name of a second SMTP server in the Secondary SMTP Server field.
a
If you need to specify a custom port for the SMTP server, enter the number in the Port field.
By default, port 25 is used.
b
If you need to use STARTTLS protocol, select the check box beside Use STARTTLS.
4
If you require specific credentials for the SMTP server authentication, click Add in the Notification Credentials section.
a
Enter the email address for the account to be used.
b
Enter the password and confirm it.
c
Click OK.
5
In the Notification Recipients section, click Add.
a
Enter the recipient’s name and email address.
b
Select the format of emails the recipient is to receive: either HTML or Plain Text.
c
Select the type of alarms the user is to receive: errors and warnings or only errors.
d
If you require that a credential be used for authentication when sending the test message, select the Use credential for send test check box and select a credential from the list you created under the Notifications Credentials section.
e
Click OK.
You can send a test message to see if the SMTP server is working by clicking the Send Test button. This ensures that UC Diagnostics can deliver a message to the specified email address.
6
Click OK.

Adding notification groups

After you have added recipients, you can create notification groups that include the recipients.

To add a notification group
1
Expand the Global Settings node in the Management Console treeview and select Notifications.
2
In the Notification Groups section, click Add.
3
Enter the sender’s name and email address.
4
If credentials are required for SMTP authentication, select the Use credential for SMTP server authentication check box.
a
Select a credential from the list of Notification Credentials and click Add.
5
Select the recipients to receive notification messages.
6
Select an external application command line to execute processes such as Passing alerts using SNMP .
7
Set limits on notifications. For more information, see Setting limits on notifications .
8
Click OK.
Tokens supported by the external command line

The following list shows the tokens that are supported for the external application command line. The tokens are replaced with corresponding real time results, when the external application is run.

Notification tokens:
•
$SenderName$
•
$SenderEmail$
Counter tokens:
•
$CounterName$
•
$CounterGroupName$
•
$CounterValue$
•
$CounterOutcome$
•
$CounterOperator$
•
$CounterThreshold$
Server tokens:
•
$ServerName$
•
$ServerOutcome$
Test tokens:
•
$TestOutcome$
•
$TestName$

The tokens dictate how many times the external application is called. The Notifications tokens are general tokens. With the Counter tokens, the external application is called once per test per each server per counter. With the Server tokens, the external application is called once per test per each server. With the Test tokens, the external application is called once per test.

Setting limits on notifications

You can configure notification groups to:

•
receive unlimited notification messages
•
receive a notification when an alarm clears
•
set the maximum number of notification messages a user is to receive per each alarm
Best practices for setting notifications

The following best practices are recommended when you set notifications:

You can receive a notification when an error occurs for a specified number of times. If the error still occurs after the specified number of times, you do not receive further notifications. In this cas you can receive a notification when the alarm is cleared. To do this:

1
Deselect the Send unlimited notifications for an alarm check box.
2
In the Maximum number of notifications to send per alarm box, enter a number for the maximum number of times you would like to receive a notification.
3
Select the Send alarm cleared notification when alarm ends check box.

You can receive unlimited error or warning notifications, but choose not receive cleared notifications. This assumes that once you stop receiving error or warning notifications, the alarm has been cleared. To do this:

1
Select the Send unlimited notifications for an alarm check box.
2
Deselect the Send alarm cleared notification when alarm ends check box.
To receive messages on cleared alarms

A cleared alarm is an alarm that recipients need not manage - either the problem has been resolved or has become less severe. For example, if you are receiving notifications on errors only, and the status changes from error to warning, the alarm is considered cleared. If you are receiving notifications on both errors and warnings, and the status changes to success, the alarm is considered cleared.

1
Add a notification group.
2
Select the Send alarm cleared notification when alarm ends check box.
3
Click OK.

If a specific event is found in the event log while you run a Server Health Test (such as an Exchange Server Health Test), an event notification is sent to the notification recipients with the corresponding severity. The next time that the Server Health Test runs, the test scans only the event logs from beyond the time of the previous test run.

If no identical event is found during the second run, the notification engine does not issue the cleared notification for the event. If the event is not found during the second test run, the problem is not necessarily resolved. It only means there are no new events logged for the exact same problem.

To receive unlimited notification messages

This feature allows you to receive unlimited notifications about alarms on counters.

1
Add a notification group.
2
Select the Send unlimited notifications for an alarm check box.
3
Click OK.

Selecting this option overrides the maximum number of notification messages you may have set.

To set the maximum number of notification messages per alarm

This feature can help you limit the number of notification emails you receive if you encounter problems with the same counter.

1
Add a notification group.
2
Enter a number in the Maximum notifications to send per alarm box.
3
Click OK.
For example, if you have a recipient configured to receive a maximum number of 3 notifications, you receive a notification the first time the alarm occurs, then two other times, if there is still a problem with the counter.
Also, you can have your notifications set to receive errors only if your performance counters on your Front-End server exceeds its error threshold, and you have selected the Send alarm cleared notification when problem ends check box. You receive a notification the first time the error occurs, and two more times if the error occurs on that performance counter again. If the fourth time, the error threshold is no longer exceeded, you receive a cleared notification.
Passing alerts using SNMP

You can pass alerts to external applications using Simple Network Management Protocol (SNMP).

1
Add a notification group.
2
Click in the Execute command line box, and enter the following:
“<Program Files>\Quest\UC Diagnostics\ManagementConsole\Binaries\iwsnmptrap.exe" <server> <community name> 6 0 "$CounterOutcome$ on $ServerName$ - $CounterName$ = $CounterValue$"
where
•
<Program Files> indicates the Program Files directory path of the computer running Diagnostic Services
•
<server> indicates the computer name to receive the SNMP trap
•
<community name> indicates the SNMP community name (usually “public”)
For example, you can enter:
"C:\Program Files\Quest\UC Diagnostics\ManagementConsole \Binaries\iwsnmptrap.exe" 10.4.60.95 public 6 0 "CounterOutcome$ on $ServerName$ - $CounterName$ = $CounterValue$”
3
Click OK.
Apply the notification group to the tests for which you want to generate SNMP traps.
Passing only errors using SNMP

If you want to pass errors only using SNMP, you can create a batch file that contains the tokens you want to use in your notifications.

1
Create a batch file, and enter:
If %1 == error "C:\Program Files\Quest\UC Diagnostics\ManagementConsole\Binaries\iwsnmptrap.exe" 10.4.60.95 public 6 0 "%1 on %2 - %3 = %4".
2
Name the batch file snmp.bat.
3
In the Notifications dialog box, add a Notifications group. Enter a Sender name and email address.
4
In the External application command line, enter:
"<directory of snmp.bat file>\snmp.bat" "$CounterOutcome$" "$ServerName$" "$CounterName$" "$CounterValue$", and save the notification group.
Using SMS notifications

You can configure UC Diagnostics for Short Message Service (SMS) notifications.

To configure SMS notifications
1
Add a notification group.
2
In the Execute command line box, enter:
<Directory of sms.vbs file>\sms.vbs “$TestName$” “$ServerName$” “$ServerOutcome$”
If the directory path to your sms.vbs file contains spaces, enclose the path with quotes.
3
Create the following sms.vbs file:
 
if (Wscript.Arguments.Count = 3) then
dim message
set message = CreateObject(“CDO.Message”)
message.From = “SOM@yourdomain.com”
message.To = “XXXXX@yourdomain.com”
message.Subject = Wscript.Arguments(1) & “ - " & Wscript.Arguments(2) & “ - " & Wscript.Arguments(0)
message.Textbody = “”
message.Configuration.Fields.Item(“http://schemas.microsoft.com/cdo/configuration/sendusing”) = 2
message.Configuration.Fields.Item("http://schemas.microsoft.com/cdo/configuration/smtpserver") = "relay.yourdomain.com"
message.Configuration.Fields.Item("http://schemas.microsoft.com/cdo/configuration/smtpserverport") = 25
message.Configuration.Fields.Update
message.Send
end if
 
This script displays Text name, Service name, and Status only, and does not send an SMS message directly. It only demonstrates a way to tailor the notification and run an external application/script.
Sending SMS messages usually depends on you service provider. They may provide you an application or some web based way to submit it. A common practice is to provide "email to text message" service.
4
Save the file to the computer where the Diagnostic Services is installed at the following location: <Program Files>\Quest\UC Diagnostics\ManagementConsole\Binaries.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating