Académique Documents
Professionnel Documents
Culture Documents
Version 6.2.4
Administrator Guide
This document may not be reproduced by any means nor modified, decompiled,
disassembled, published or distributed, in whole or in part, or translated to any
electronic medium or other means without the prior written consent of SolarWinds.
All right, title, and interest in and to the software and documentation are and shall
remain the exclusive property of SolarWinds and its respective licensors.
The SolarWinds and other SolarWinds marks, identified on the SolarWinds website,
as updated from SolarWinds from time to time and incorporated herein, are
registered with the U.S. Patent and Trademark Office and may be registered or
pending registration in other countries. All other SolarWinds trademarks may be
common law marks or registered or pending registration in the United States or in
other countries. All other trademarks or registered trademarks contained and/or
mentioned herein are used for identification purposes only and may be trademarks
or registered trademarks of their respective companies.
Introduction 38
Applications Defined 39
SAM hardware requirements 44
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers 49
Agent requirements 51
Server sizing 54
Recommendations 55
5
SolarWinds Server & Application Monitor Administrator Guide
Recommendations for multi-CPU systems and the optimal settings of the I/O subsystem 57
Enable FIPS 60
SAM technology requirements 67
6
Table of Contents
Customize resources 87
Customize views 95
7
SolarWinds Server & Application Monitor Administrator Guide
Minimize SNMP processing load during discoveries using the Discovery Ignore List 144
8
Table of Contents
Groups 157
Add a summary view menu item to the menu bar in the Applications tab: 177
178
Manage nodes, applications, and settings from the web console 181
9
SolarWinds Server & Application Monitor Administrator Guide
Add, edit, and delete credentials within the Credentials Library 189
189
Create and assign credentials using Quick Credentials when editing a template or
application monitor. 193
10
Table of Contents
View events, alerts, traps, and syslogs in the Orion Web Console Message Center 237
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers 245
11
SolarWinds Server & Application Monitor Administrator Guide
12
Table of Contents
Install and configure the SolarWinds Alert Integration application in ServiceNow 343
13
SolarWinds Server & Application Monitor Administrator Guide
Adapt an existing Perl script to a Linux/Unix Script component monitor in a new template 378
Adapt an existing Visual Basic script to a Windows Script Monitor in a new template 384
14
Table of Contents
445
15
SolarWinds Server & Application Monitor Administrator Guide
Agents 518
16
Table of Contents
17
SolarWinds Server & Application Monitor Administrator Guide
Alerting 560
18
Table of Contents
Reports 644
Viewing, Creating, Exporting, Importing, Editing and Scheduling Reports in the Orion Web
Console 644
OrionGlobalSearch 666
Search syslogs, traps and objects monitored in the Orion Web Console globally 666
NetworkAtlasAdminGuide 671
19
SolarWinds Server & Application Monitor Administrator Guide
20
Table of Contents
References 755
Zooming 763
Zooming 826
Change thresholds for the Top Indexes for Database performance counter 843
Changing the number of tables displayed in this resource requires values be changed in two
locations 843
Change the thresholds for the Top Indexes for Database performance counter 847
Change thresholds for the Top Tables for Database performance counter 849
Zooming 863
Zooming 899
Zooming 1006
Zooming 1009
21
SolarWinds Server & Application Monitor Administrator Guide
1034
1034
22
Table of Contents
Agents 1048
Viewing and customizing application and component performance and status 1051
1054
JSON 1060
23
SolarWinds Server & Application Monitor Administrator Guide
Definitions 1061
Drivers 1067
Firmware 1068
Memory 1073
Peripherals 1077
Processors 1079
General 1085
Hardware 1085
24
Table of Contents
Availability 1102
25
SolarWinds Server & Application Monitor Administrator Guide
Zooming 1105
Zooming 1109
26
Table of Contents
Add, edit, and delete credentials within the Credentials Library 1171
1171
27
SolarWinds Server & Application Monitor Administrator Guide
28
Table of Contents
29
SolarWinds Server & Application Monitor Administrator Guide
30
Table of Contents
31
SolarWinds Server & Application Monitor Administrator Guide
Characters 1281
Anchors 1283
Quantifiers 1284
Dot 1286
Alternation 1287
Solutions 1295
Troubleshooting 1297
32
Table of Contents
Configure Distributed Component Object Model (DCOM) and User Account Control (UAC) 1305
33
SolarWinds Server & Application Monitor Administrator Guide
34
Table of Contents
35
Before you install
Before you install SAM, you should explore this section which contains information on different technology
and licensing requirements.
n SAM hardware requirements
n Additional SAM technologyrequirements
37
Introduction
SolarWinds Server & Application Monitor (SolarWinds SAM) allows you to create and
monitor your own custom collection of monitored components, providing an open
field of opportunity to the network engineer. It also allows you to create flexible
Application Monitor templates to combine process monitors, port availability, and
performance counters, allowing you to assess the status of every aspect of your
application and the health of the application as a whole.
The following illustration shows a basic visualization of how SolarWinds Server &
Application Monitor works:
38
Applications Defined
In SolarWinds SAM, an application is a collection of component monitors inherited
from a template. A component monitor queries for values returned by a process,
counter, status, or script. SolarWinds SAM uses the data received to display vital
statistics concerning the health of the system.
The following illustration explains the template and application relationship. If you
make a change at the template level, the applications based on that template are
affected. Conversely, if you make a change at the application level, only the individual
application is affected.
This inheritance relationship is beneficial if you need to make a lot of changes. For
example, rather than making one change to 100 applications (and therefore 100
changes), you can change one item that affects all 100 applications based on that
template.
39
How Does SolarWinds Server & Application Monitor Work?
40
As a standalone product, SAM operations can be visualized with the following
flowchart:
41
How Does SolarWinds Server & Application Monitor Work?
42
Requirements and Installation
Prepare a SolarWinds Orion Platform installation
Orion Platform products use a simple wizard to direct the installation process.
Downgrades of Orion Platform products are not supported. If you are upgrading or installing
multiple products, confirm that you are installing them in the order given in the upgrade
instructions located in your SolarWinds Customer Portal or in the Upgrade Guide.
SAM hardware requirements
Important: These system requirements define the minimum requirements for SAM 6.2.4 as a single
installed product. You may need to increase your requirements in small, medium, or large
environments with multi-modules installed.
The following table lists minimum hardware requirements and recommendations for your
SolarWinds Orion server. Installing multiple SolarWindsOrion Platform products on the same computer
may change the requirements.
4 GB 10 GB 25 GB
A RAID 1 drive for the server operating system, SolarWinds installation, and
tempdb files is recommended. The SolarWinds installer needs 1GB on the drive
where temporary Windows system or user variables are stored. Per Windows
Hard drive standards, some common files may need to be installed on the same drive as
space your server operating system.
The Orion installer needs 2 GB on the drive where temporary Windows system or user
variables are stored.
Some common files may need to be installed on the same drive as your server
operating system.
44
HARDWARE AL150 - AL300 AL700 - AL1100 AL1500-ALX
n 17778 (Active mode): In Active mode, no ports need to be open on the host where
the agent is installed. However, TCP port 17778 must be open on the Orion server
or the additional poller with which the agent is associated. This port must be
opened on the Orion server (inbound) and allowed by the firewall. It is used on a
continual basis once the agent has been deployed. Communication is initiated
Agent Open outbound from the agent to the Orion server.
Port
Requirements: Important: This requirement is for Active agents only. If Passive agents are used,
no ports need to be opened on the firewall for the Orion server. For more
information, see Changing the Agent Port.
n 17790 (Passive mode): In Passive mode, port 17790 must be opened on the host
where the agent is installed and allowed by the firewall.
45
SOFTWARE REQUIREMENTS
Production Evaluation Only
Operating
system n English
languages
IPv4
IP address IPv6 implemented as a dual stack. For more information, see RFC 4213 - Basic Transition
version Mechanisms for IPv6 Hosts and Routers.
Web characters (_) are not allowed. For more information, see RFC 952 - DOD
server Internet Host Table Specification.
n IIS is installed by the SolarWinds installer. You can install this software
manually to reduce your installation time or network bandwidth.
n SolarWinds products are not compatible with IIS version 6.0 installations that
use web gardens.
.NET .NET 4.5
Framework
Compatible with 4.6.1
46
SOFTWARE REQUIREMENTS
n Safari for iPhone
Other MSMQ
The following services must be running after installation is complete to collect syslog
messages and traps:
Services
n SolarWinds Syslog Service
n SNMP Trap Service
Multiple SolarWinds Orion server installations using the same database are not supported.
The following table lists software and hardware requirements for your SolarWinds Orion database server
using SolarWindsNPM license levels as a reference.
47
REQUIREMENTS AL150 - AL300 AL700 - AL1100 AL1500-ALX
n SQL Server 2008 R2, 2008 R2 SP1, 2008 R2 SP2, or 2008 R2 SP3
n SQL Server 2012, 2012 SP1, 2012 SP2, or 2012 SP3
n SQL Server 2014 or 2014 SP1
n SQL Server 2016
n Due to latency effects, SolarWinds does not recommend installing your SQL
Server and your SolarWinds server or additional polling engine in different
locations across a WAN. For more information, see this SolarWinds
Knowledge Base article,
n Either mixed-mode or SQL authentication must be supported.
n If you are managing your Orion database, SolarWinds recommends you
install the SQL Server Management Studio component.
4 GB 10 GB 25 GB
Per Windows standards, some common files may need to be installed on the same drive
as your server operating system.
Memory and Each additional poller requires 8GB of additional RAM. For example, SAM plus 2
Additional additional pollers would require 24GB of RAM. 3 additional pollers would require 32GB
Pollers of RAM, and so on.
If you are managing your SolarWinds Orion database, SolarWinds recommends you
Other install the SQL Server Management Studio component.
software The Installation Wizard installs the following required x86 components if they are not
found on your Orion database server:
48
REQUIREMENTS AL150 - AL300 AL700 - AL1100 AL1500-ALX
l SQL Server System Common Language Runtime (CLR) Types. Orion products use
secure SQL CLR stored procedures for selected, non-business data operations to
improve overall performance.
l Microsoft SQL Server Native Client
l Microsoft SQL Server Management Objects
SAM's PowerShell Script Monitor works with PowerShell 1.0 and higher for local
execution.
You must maintain your SQL Server database on a separate, physical server.
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers
REQUIREMENT DESCRIPTION
SNMP must be enabled on all ESXi and ESX servers. For more information, consult your
SNMP
ESX or ESXi server vendor documentation.
VMware
VMware Tools must be installed on all virtual machines you want to monitor.
tools
49
REQUIREMENT DESCRIPTION
If your virtual machines are on monitored ESXi and ESX servers, VMware Tools are not a
requirement but provide access to additional information, such as IP addresses.
For more information about requirements, see IVIM Minimum Requirements in the SolarWinds
Virtual Manager documentation.
The following methods are used by SolarWinds Orion to monitor VMware ESX Servers and their component
features.
FEATURES 4 4i 5i 6.0
Total CPU
VMware API
(ESX details view)
Total memory
VMware API
(ESX details view)
Guest VM list
VMware API
(ESX details view)
If your devices do not use the default syslog port to send messages, you must also modify the
SolarWinds Orion server to listen to that port.
Some features, such as agents or Quality of Experience (QoE) monitoring, have extra or different
requirements on the host computers.
50
n Agent requirements
n Quality of Experience requirements
Agent requirements
Agent software is free. You remain bound by the limits of the license you own regardless of how
information is polled, either through an agent or another polling method.
Before you deploy agents to a target computer, review the following system requirements.
TYPE REQUIREMENTS
The following operating systems are supported for both 32-bit and 64-bit computers:
Only Pro, Enterprise, and Ultimate workstation operating systems editions are
supported.
The following software packages are installed by the agent installer if necessary:
The VeriSign Root Certificate Authority (CA) must be current. This is required because the
agent software is signed using a VeriSign certificate. To install a certificate, see Certificates
Security and the agent.
After the agent is installed, it runs as the Local System account and does not require
administrative permissions to function.
If you want to deploy agents from the SolarWinds Orion server, the following requirements
Account must be met:
permissions n The account used for remote deployment must have access to the administrative
share on the target computer: \\<hostname_or_ip>\admin$\temp.
51
TYPE REQUIREMENTS
n User Account Control (UAC) must either be disabled on the target computer, or the
built-in Administrator account must be used.
Other remote or mass deployment methods do not have the same requirements.
HDD Approximately 100 MB of hard drive space on the target computer, for installation only
RESOURCE CONSUMPTION
CPU Less than 1% on average under normal operating conditions (0.24% on average)
Roughly 20% (on average) of the bandwidth consumed by the WMI protocol for transmission
Bandwidth of the same information
For example, Agent: 1.3 kB/s versus WMI at 5.3 kB/s
For agent-initiated communications, port 17778 (inbound) must be open on SolarWinds Orion servers
running Windows Server 2012 or port 17791 on SolarWinds Orion server running Windows Server 2008 R2
SP1 and communication through the port must be allowed by the firewall. It is used continuously after the
agent is deployed. Communication is initiated outbound from the agent to the Orion server.
For server-initiated communications, port 17790 must be opened (inbound) on the remote computer.
n 135 (DCE/RPC Locator service) Microsoft EPMAP. This port must be open on the client computer
(inbound) for remote deployment.
n 445 Microsoft-DS SMB file sharing. This port must be open on the client computer (inbound) for
remote deployment.
Before you deploy a Packet Analysis Sensor to a device to monitor QoE, review the following minimum
system requirements.
Sensors cannot be installed on 32-bit computers and do not support communication over https.
52
Network Packet Analysis Sensors (NPAS)
HARDWARE/SOFTWARE REQUIREMENTS
Windows 7 or later, 64-bit
View your vendor documentation for instructions about how to set up port
mirroring. You can create port mirrors for both physical switches and virtual
switches.
HARDWARE/SOFTWARE REQUIREMENTS
53
HARDWARE/SOFTWARE REQUIREMENTS
By default, SolarWinds Syslog Service listens for syslog messages on port 514 (UDP). If your devices use a
different port for sending syslog messages, consider reconfiguring the port on devices, or change the port
on which the service listens.
If you run the Configuration Wizard, you must repeat this procedure to restore the port setting.
Server sizing
Listed from the most important to the least important are the primary variables that affect scalability.
An element is defined as a single, identifiable node, interface, or volume. Systems monitoring more
than 10,000 elements may require tuning for optimal performance. Monitoring some node types,
such as routers, place more load on the system.
Polling frequency
If you are collecting statistics every five minutes instead of the default nine minutes, the system will
have to work harder and system requirements will increase.
The number of simultaneous users accessing SolarWinds Orion directly impacts system
performance.
54
Recommendations
When planning a SolarWinds Orion installation, there are four main factors that limit your polling capacity:
n CPU
n Memory
n Number of polling engines
n Polling engine settings
Install your SolarWinds Orion product and SolarWinds Orion database on different servers
If you plan to monitor 2,000 elements or more, SolarWinds recommends that you install your product
and your database on different servers. Separate servers for the product and the database improve
the performance, as the product server does not perform any database processing, and it does not
have to share resources with the database server.
If you plan to monitor 10,000 or more elements, SolarWinds recommends that you install additional
polling engines on separate servers to help distribute the work load.
For more information about sizing SolarWinds Orion to your network, view the Scalability Engine
Guidelines (PDF), contact the SolarWinds sales team, or visit www.solarwinds.com.
If there are more databases on a given SQL server, it is strongly recommended that you use
dedicated hard drives for the tempdb database. Use at least one hard drive for data files, and one
hard drive for the transaction log. All databases use the same tempdb, therefore the tempdb can
be the biggest bottleneck in the I/O subsystem.
When planning your SQL server configuration, consider the following information:
n SQL Express is only suitable for small SolarWinds Orion installations without NTA. NetFlow can be a
major factor in database sizing, depending on the incoming flow rates.
n WAN connections should never be used between the SQL server and the SolarWinds Orion server.
This includes any additional pollers.
n Do not install the SQL server on the Orion server.
55
n The performance of the SQL server is dependent on the performance of the I/O subsystem.
n The more disks there are in a RAID 10 array, the better.
n Many RAID controllers do not handle RAID 01 well.
The following section contains the recommended hardware settings for SQL servers, taking into account
different scenarios and the number of logical disks you use.
COMPONENT RECOMMENDATION
n A dedicated RAID 1+0 hard drive for data files (.mdf, .ndf).
Orion database n A dedicated RAID 1+0 hard drive with fast sequential writing for
transaction files (.ldf).
COMPONENT RECOMMENDATION
n A dedicated RAID 1+0 hard drive for data files (.mdf, .ndf).
Orion database n A dedicated RAID 1+0 hard drive with fast sequential writing for
transaction files (.ldf).
SQL Server host system n A dedicated hard drive of any type. This hard drive should be the
(Windows) slowest of the four available disks.
COMPONENT RECOMMENDATION
n A dedicated RAID 1+0 hard drive for data files (.mdf, .ndf).
Orion database n A dedicated RAID 1+0 hard drive with fast sequential writing for
transaction files (.ldf).
56
COMPONENT RECOMMENDATION
SQL Server temporary
directory (tempdb)
n A dedicated hard drive for tempdb data files (.mdf, .ndf), tempdb
database and
transaction log (.ldf), and host system.
SQL Server host system
(Windows)
n Use the disk with the faster sequential writing for the host system and for the transaction log files
(.ldf).
n Use the other disk for data files (.mdf, .ldf), for the tempdb data files, and for the tempdb log files.
Recommendations for multi-CPU systems and the optimal settings of the I/O subsystem
On multi-CPU systems, the performance of some operations can be increased by creating more data files
on a single hard drive.
The following example shows the original settings of a system with 16 CPU cores:
n One hard drive for data with the SolarWindsOrionDatabase.MDF file in the Primary filegroup.
n One hard drive for the transaction log with the SolarWindsOrionDatabase.LDF file.
n One hard drive for the tempdb data with the tempdb.MDF file in the Primary filegroup.
n One hard drive for the tempdb transaction log with the tempdb.LDF file.
n One hard drive for data, with the following files in the Primary file group:
n SolarWindsOrionDatabase01.MDF
n SolarWindsOrionDatabase02.MDF
n SolarWindsOrionDatabase03.MDF
n SolarWindsOrionDatabase04.MDF
n One hard drive for the transaction log with the SolarWindsOrionDatabase.LDF file.
n One hard drive for tempdb data, with the following files in the Primary filegroup:
n tempdb01.MDF
n tempdb02.MDF
n tempdb03.MDF
n tempdb04.MDF
n One hard drive for the tempdb transaction log with the tempdb.LDF file.
n Having more files in the filegroup help the SQL server to distribute the load generated by
57
multiple threads while working with files.
n The recommended ratio between the number of cores and the files in the filegroup is typically
4:1 or 2:1 (for example, 16 cores and four files, or 16 cores and eight files).
n The size and growth setting for all files in a filegroup must be set to identical values in order
to distribute the load evenly.
n For the transaction log, it is not effective to create more files, because the SQL server can only
use the first file.
n For the tempdb database, a RAM disk or an SSD disk can be used.
n An SSD disk can be used for data files, but it is not effective for the transaction log where
sequential access is most important.
n Do not reserve all memory to the SQL server, because this can lead to a lack of memory for the host
operating system.
n Reserve 1 GB of memory to the host operating system if there are no additional services running on
the given host system.
n If additional resource-intensive services are running on the host operating system, reserve sufficient
memory for the host operating system. SolarWinds does not recommend such configuration.
For best performance, SolarWinds also recommends creating an antivirus directory exclusion for the
SolarWinds install folder.
SolarWinds Orion Platform products support the use of Secure Sockets Layer certificates to enable secure
communications with the Orion Web Console.
58
Requirements
Due to security concerns, SolarWinds recommends that you disable SSL v3.0 and earlier.
1. Add a binding to https port 443 for the SolarWinds NetPerfMon site. For more information, consult
the Microsoft online documentation on setting up SSL.
2. Enable the Orion Web Console for SSL.
3. You can also configure the Orion Web Console to require SSL.
1. Log in to your SolarWinds Orion server using an account with administrative rights.
2. Shut down all SolarWinds services. Start the Orion Service Manager in the SolarWinds Orion >
Advanced Features program folder, and click Shutdown Everything.
3. Start the Database Manager from the SolarWinds Orion > Advanced Features program folder.
4. Expand the SQL servers, and navigate to SQL Servers > your SolarWinds Orion database
server > SolarWindsOrion > Websites in the left pane.
n If your SQL Server is not listed in the left pane, click Add Default Server.
n If your Orion database is not listed in the left pane, add it:
a. Click Add SQL Server.
b. Using the format Server/Instance, select or provide the SQL Server instance you are
using as your SolarWinds Orion database.
c. Select the login method, providing credentials as required.
d. Click Connect to Database Server.
5. Right-click the Websites table, and click Query Table.
6. Replace the default query with the following query, and click Refresh.
UPDATE dbo.Websites SET SSLEnabled=1 WHERE WebsiteID=1
7. Switch to the Orion Service Manager, and click Start Everything.
8. Change the Orion Web Console port.
a. Start the Configuration Wizard in the SolarWinds Orion > Configuration and Auto-Discovery
program folder.
b. Select Website, and click Next on the Welcome window.
c. Enter the SSL port number, and click Next.
Port 443 is typically reserved for SSL traffic.
d. Review the configuration summary, and complete the Configuration Wizard.
1. In a text editor, open the web console configuration file, web.config, on your primary SolarWinds
server.
59
The default location of web.config is C:\Inetpub\SolarWinds\.
Enable FIPS
FIPS (Federal Information Processing Standard) defines security and interoperability standards for
computers used by the U.S. federal government.
Monitored nodes and network discoveries must use FIPS-compliant authentication and privacy or
encryption methods.
FIPS-COMPLIANT METHODS
Authentication SHA1
SolarWinds recommends that you install all FIPS-compliant SolarWinds software on FIPS-compliant
servers and maintain all non-compliant SolarWinds software on non-compliant servers.
1. Configure the Orion Platform product server for FIPS compliance. See the Microsoft Support
knowledge base for more information.
2. Start the SolarWinds FIPS 140-2 Manager (SolarWinds.FipsManager.exe).
60
3. Read the welcome text, and click Next.
The SolarWinds FIPS 140-2 Manager will confirm that the current configuration of your SolarWinds
products is FIPS-compliant.
n If an installed Orion Platform product is not FIPS-compliant, click Close, remove any non-
compliant Orion Platform products from the FIPS-compliant server, and run the FIPS 140-2
Manager again.
n If FIPS 140-2 is disabled, select Enable FIPS 140-2, and click Next.
n If the FIPS Manager provides a list of objects or saved network discovery definitions that are
not FIPS-enabled, complete the following steps.
To refresh the list of non-compliant objects after editing the credentials, restart the FIPS
140-2 Manager.
n Click the non-compliant monitored node, and edit its Polling Method to be FIPS-
compliant.
a. Select SNMPv3 as the SNMP Version.
b. Select FIPS-compliant Authentication and Privacy/Encryption methods, and
provide the passwords.
c. Click Submit.
n Click the non-compliant network discovery, and edit SNMP credentials to be FIPS-
compliant.
a. Confirm that all SNMP credentials are SNMPv3. Delete or edit any credentials that
are not FIPS-compliant SNMPv3.
b. Confirm that all SNMP credentials use FIPS-compliant Authentication and
Privacy/Encryption methods, and provide the passwords.
c. Complete the Network Sonar Wizard using the updated credentials.
4. Click Restart now to restart all relevant SolarWinds services.
Ensure that all Orion Platform products have access to all required files by excluding the following
directory, listed by operating system, from antivirus protection.
Windows 2008
C:\ProgramData\SolarWinds\
For example, if you purchase SolarWinds NPM with an SL100 license and SolarWinds SAM with an AL50
license, use the following to calculate how many nodes or components you can monitor:
61
When you purchase both licenses, you can monitor the performance of both interfaces and applications on
a total of 150 unique nodes or components because the SAM license adds 50 to the 100 nodes allowed
with your NPM license.
For more information, see the administrator guide of your specific Orion Platform product.
When you install your Orion Platform product, you are prompted to provide your licensing information
(software license key and customer data), and activate your product.
To postpone the activation, click Continue Evaluation. You can activate the license later, with the
License Manager.
b. Under the Licensing Management section on the top bar, select License Management.
c. Browse to the SolarWinds product, and click the plus sign next to the product to display your
activation key.
d. Copy your unregistered activation key for the SolarWinds product to the clipboard, and paste
it into the Activation Key field in the Activate window.
3. If you are using a proxy server to access the Internet, select I Access the Internet Through a Proxy
Server, and enter the proxy address and port number.
4. Click Next.
5. Provide your customer data, and complete the Activation Wizard.
62
Activate licenses offline
1. On the Activate Product window, select This Server Does Not Have Internet Access, and click Next.
2. To finalize your registration, click Copy Unique Machine ID.
3. Paste the data into a new document in a text editor, and save the text document.
4. Transfer the document to a computer with Internet access. For example, transfer the document to a
shared location.
5. Log in to the SolarWinds customer portal and find your activation key:
a. Browse to https://customerportal.solarwinds.com from a computer with Internet access, and
then log in using your Customer ID and password, or your individual user account
information.
If you do not know your SolarWinds Customer ID and password or individual profile
details, contact Customer Support and submit a ticket.
For instant license management, the computer must have internet connectivity.
Connectivity You can also manage licenses using offline activation and deactivation. You must have
online access to the SolarWinds Customer Portal from another computer.
.NET
.NET 4.5
Framework
n Windows Server 2008 R2 SP1
n Windows Server 2012
n Windows Server 2012 R2
Operating
system For evaluation purposes:
n Windows 7 SP1
n Windows 8 (except for Standard edition)
63
ITEM REQUIREMENT
n Windows 8.1 (except for Standard edition)
n Windows 10
Install License Manager on the computer with SolarWinds products installed. The License Manager can
only license products on that computer.
You must install License Manager on a computer with the correct time.
1. Start the SolarWinds License Manager Setup in the SolarWinds program folder.
If problems with License Manager occur, or if or the computer does not have access to the
Internet, download and install the latest version of License Manager from
http://solarwinds.s3.amazonaws.com/solarwinds/Release/LicenseManager/LicenseManager.z
ip
2. Click Next to accept the SolarWinds EULA, and click Install.
With the License Manager, you can manage licenses for multiple SolarWinds products.
2. Click Activate next to the SolarWinds product, and complete the Activation Wizard.
n Activate licenses with Internet access
a. On the Activate Product window, select I Have Internet Access...
b. Find your activation key in the customer portal, and enter it in the Activation Key field.
a. Browse to https://customerportal.solarwinds.com, and then log in using your
Customer ID and password, or your individual user account information.
If you do not know your SolarWinds Customer ID and password or individual
profile details, contact Customer Support and submit a ticket.
b. Under the Licensing Management section on the top bar, select License
Management.
c. Browse to the SolarWinds product, and click the plus sign next to the product to
64
display your activation key.
d. Copy your unregistered activation key for the SolarWinds product to the
clipboard, and paste it into the Activation Key field in the Activate window.
c. If you are using a proxy server to access the Internet, select I Access the Internet
Through a Proxy Server, and enter the proxy address and port number.
d. Click Next.
e. Provide your customer data, and complete the Activation Wizard.
n Activate licenses offline
a. On the Activate Product window, select This Server Does Not Have Internet Access, and
click Next.
b. To finalize your registration, click Copy Unique Machine ID.
c. Paste the data into a new document in a text editor, and save the text document.
d. Transfer the document to a computer with Internet access. For example, transfer the
document to a shared location.
e. Log in to the SolarWinds customer portal and find your activation key:
a. Browse to https://customerportal.solarwinds.com from a computer with Internet
access, and then log in using your Customer ID and password, or your individual
user account information.
If you do not know your SolarWinds Customer ID and password or individual
profile details, contact Customer Support and submit a ticket.
If you decide to move your SolarWinds product to another server, you must deactivate the license on the
original computer, and reactivate it on the server with the new installation.
You can deactivate and reuse the licenses to install product versions that were released during your
maintenance period. You cannot deactivate and reuse licenses to install products that were
released after your maintenance period expired. To license these products, you must renew your
maintenance or re-license your product.
65
Deactivate, move, and assign licenses online
1. Log in to the computer where the licensed SolarWinds product is installed.
2. Start the License Manager in the SolarWinds program folder.
3. Select the products you want to deactivate on this computer, and click Deactivate.
You can deactivate more than one product at the same time.
In certain products, you can deactivate licenses by using the internal licensing tool of the product.
4. Complete the deactivation wizard.
5. Log in to the computer on which to install your products, and begin installation.
6. When asked to specify your licenses, provide the information. The license you deactivated earlier is
assigned to the new installation.
1. Log in to the computer where the licensed SolarWinds product is installed.
2. Start the License Manager in the SolarWinds program folder.
3. Select the products you want to deactivate on this computer, and click Deactivate.
You can deactivate more than one product at the same time. The deactivation file will contain
information about each product.
In certain products, you can deactivate licenses by using the internal licensing tool of the product.
4. Complete the deactivation wizard, and save the deactivation file.
5. Log in to the SolarWinds Customer Portal, and navigate to the License Management page.
6. Select your product instance, and click Deactivate License Manually.
7. In the Manage License Deactivation page, locate the deactivation file you created in License Manager,
and click Upload.
The deactivated licenses are now available to activate on a new computer.
The new License Manager tool allows offline deactivation with a created file that can be
uploaded to the Customer Portal.
8. Log in to the computer on which to install your products, and begin installation.
9. When asked to specify your licenses, provide the information. The license you deactivated earlier is
assigned to the new installation.
If you have changed how your product is licensed, such as by increasing the number of objects you can
monitor, use the License Manager to apply the change to your products.
1. Start the License Manager from the SolarWinds program group.
2. Click Upgrade in the Action column next to the products for which you want to upgrade the license
on this computer.
3. Complete the Activation Wizard.
66
Synchronize licenses to the Customer Portal
For most Orion Platform products licenses, you can synchronize the data on your Customer Portal with the
data in the License Manager.
License synchronization takes place automatically once a day. If the automatic synchronization does not
occur, or you want to update your licenses immediately, you can synchronize your installed licenses with
the SolarWinds Customer Portal:
1. Start the License Manager from the SolarWinds program group.
2. Select the product, and click Synchronize.
3. Click Synchronize again in the Synchronize Licenses window.
The License Manager synchronizes with the Customer Portal and any updates in the Customer Portal are
reflected in the License Manager.
SAM technology requirements
67
SNMP requirements for monitored devices
SolarWinds SAM can monitor the performance of any SNMPv1, SNMPv2c, or SNMPv3 enabled device on
your network. Consult your device documentation or a technical representative of your device
manufacturer to acquire specific instructions for configuring SNMP on your device.
Enterprise-level SolarWinds SAM deployments with the potential for more than 1,000 monitors may need
additional computing resources above the standards required for SolarWinds common components.
Asset inventory data collection can be enabled for both physical and virtual assets and functions
independently of hardware health monitoring. This means you do not need to have hardware health
monitoring enabled to have inventory data collected and displayed.
n Dell servers with OpenManage Server Administrator Managed Node v7.2 or later
n HP servers with HP System Insight Manager v6.2 or higher
n IBM server with IBM Director (Common Agent, v6.3 or higher)
n Additional hardware not listed here may be supported with a limited amount of information
returned from the polling process.
The Asset Inventory feature supports the following operating systems and protocols and does not count
against your SAM component monitor license. Additionally, these nodes must be managed by SAM to
enable collection of Asset Inventory data:
Linux SNMP
HP
68
n HP ESXi Offline Bundle
n HP Management Agents for VMware ESX 4.x Only (Not for ESXi 4.x)
n HP ESXi Offline Bundle for VMware ESXi 5.0
HP/VMware
n HP Management Agents for VMware ESX 4.x Only (Not for ESXi 4.x)
n HP Insight Management WBEM Providers for ESXi 5.0
n HP ESXi Offline Bundle for VMware ESXi 5.0
Dell/VMWare
IBM
VMware
n HP Management Agents for VMware ESX 4.x Only (Not for ESXi 4.x)
n HP Insight Management WBEM Providers for ESXi 5.0
n HP ESXi Offline Bundle for VMware ESXi 5.0
n Dell OpenManage Support for VMware ESXi 5.x
AppInsight for SQL supports the following versions of Microsoft SQL Server:
AppInsight for SQL data is collected at the same default five minute polling interval as traditional
application templates. Following are the requirements and permissions needed for AppInsight for SQL.
Important: AppInsight for SQL does not require named-pipes. However, it does require TCP. For
example, SAM uses TCP detection during discovery. You may receive an error message pertaining to
"named-pipes." This is the result of the last client protocol that is tried during connection to the
SQL server.
The minimum SQL permissions required to use AppInsight for SQL are as follows:
69
n Must be a member of the db_datareader role on the msdb system database.
n Must have VIEW SERVER STATE permissions.
n View any definition.
n Connect permission to Master database.
n Execute permission on the Xp_readerrorlog stored procedure.
n Connect permission to the Msdb database.
n Must be member of db_datareader role in the MSDB database.
n Connect permission to all databases.
Notes:
n AppInsight for SQL supports both the SNMP and WMI protocols and uses SQL to gather information
about the application. Additional information is available for nodes managed via WMI.
n Agents do not work with AppInsight for SQL when the SQL server being monitored is in a cluster.
n SQL clusters cannot be polled with domain credentials via the Orion Agent because Agents do not
work with AppInsight for SQL when the SQL server being monitored is in a cluster.
Important: This following scripts make changes directly to the database. You should create a
database backup before running either of these scripts.
USE master
GRANT VIEW SERVER STATE TO AppInsightUser
GRANT VIEW ANY DEFINITION TO AppInsightUser
GRANT VIEW ANY DATABASE TO AppInsightUser
EXEC sp_adduser @loginame = 'AppInsightUser' ,@name_in_db =
'AppInsightUser'
GRANT EXECUTE ON xp_readerrorlog TO AppInsightUser
USE msdb
EXEC sp_adduser @loginame = 'AppInsightUser' ,@name_in_db =
'AppInsightUser'
EXEC sp_addrolemember N'db_datareader', N'AppInsightUser'
The following script configures permissions for a SQL account with Windows Authentication:
USE master
GRANT VIEW SERVER STATE TO "Domain\AppInsightUser"
GRANT VIEW ANY DEFINITION TO "Domain\AppInsightUser"
EXEC sp_adduser @loginame = 'Domain\AppInsightUser' ,@name_in_db =
'Domain\AppInsightUser'
GRANT EXECUTE ON xp_readerrorlog TO "Domain\AppInsightUser"
USE msdb
EXEC sp_adduser @loginame = 'Domain\AppInsightUser' ,@name_in_db =
'Domain\AppInsightUser'
EXEC sp_addrolemember N'db_datareader', N'Domain\AppInsightUser'
EXECUTE sp_MSforeachdb 'USE [?]; EXEC sp_adduser @loginame =
70
''Domain\AppInsightUser'', @name_in_db = ''Domain\AppInsightUser'''
AppInsight for Exchange works only with the Mailbox Role, which is used for data storage. All other
Exchange servers running different roles should use the Exchange application templates included with
SAM if you intend to monitor them. Data is collected at the same default five minute polling interval as
traditional application templates.
Following are the requirements and permissions needed for AppInsight for Exchange:
n Local administrator permissions are needed for automatic configuration, but they are not needed for
monitoring once configuration is complete.
n To provide organization-wide capability, the service account (Domain User) needs to be a member of
the View-Only Organization Management group. Membership to this group gives the user object
read-only access to the entire Exchange environment, without providing any domain or local access
on the Exchange server. It also prevents possible abuse by an unauthorized user accessing the
account (e.g. modifying Exchange environment configuration, creating or deleting users, and so on.)
n In order to gather information, the user object must be assigned the Mailbox Search management
role within Exchange. In order for the account to be configured correctly, the account must be a
member of the Local Administrators group.
Note: For Exchange access, this is not required, but in order to modify Exchange and WinRM settings
on the server, as well as to poll performance counters, this additional level of permission is required.
n For Mailbox statistics, Hub Transport Servers need to be accessed via RPC.
PowerShell Requirements
n To add local administrative privileges to an Active Directory account, see Non-Domain Account.
n To find Exchange URL settings, see Find Exchange URL settings.
n To install PowerShell on the Exchange server, see Non-Domain Account.
71
AppInsight for IIS requirements and permissions
AppInsight for IIS data is collected at the same default five minute polling interval as traditional
application templates. Following are the requirements needed for AppInsight for IIS:
Notes:
The following table outlines the technologies and ports used by AppInsight for IIS:
The IIS server must have the ports open on the managed nodes.
RPC TCP port 135 SAM uses this port to establish WMI/RPC connections to the remote
Endpoint computer. RPC is required for getting performance counters
Mapper information via the ASP.NET resource.
WMI TCP ports 1025 - By default, Microsoft Windows uses a random port from this range
5000 or TCP ports for WMI communications. The default port range differs based on
49152 - 65535 the operating system. You must create a firewall exception on the
remote computer.
PowerShell TCP port 5986 This is a secure listener hosted in the WinRM service.
72
HTTP TCP, At least one If the connection is not allowed, the HTTP Monitor is hidden.
port mentioned in
the bindings of a
site.
HTTPS TCP. At least one If the connection is not allowed, the HTTPS Monitor will be hidden.
port mentioned in
the secure bindings
of a site.
SSL TCP. At least one If the connection is not allowed, the SSL Certificate Expiration Date
port mentioned in Monitor will be hidden.
the secure bindings
of a site.
SMB TCP port 445 Used for Site Directory Information and Log Directory Information.
(Windows
Shares)
When SAM is installed on Windows 2003 R2 SP2, scheduled tasks on Windows 2008 or later cannot
be polled by the Windows Scheduled Task Monitor (WSTM). Only tasks from root directory can be
monitored. The WSTM will not work for tasks from every level of the Task Scheduler Library.
SolarWinds SAM can monitor the performance of any SNMPv1-, SNMPv2c-, or SNMPv3-enabled device on
your network. Consult your device documentation or a technical representative of your device
manufacturer to acquire specific instructions for configuring SNMP on your device.
Notes:
n To properly monitor devices on your network, you must enable SNMP on all devices that are capable
of SNMP communications.
n Unix based devices should use the configuration of Net-SNMP version 5.5 or higher that is specific to
the type of Unix-based operating system in use.
73
n SolarWinds SAM is capable of monitoring VMware ESX and ESXi Servers versions 3.5 and higher with
VMware Tools installed on virtual machines. For more information about enabling SNMP and
VMware Tools on your VMware device, consult your VMware documentation or technical
representative.
n If SNMPv2c is enabled on a device you want to monitor, by default, SolarWinds SAM attempts to use
SNMPv2c to poll the device for performance information. If you only want SolarWinds SAM to poll
using SNMPv1, you must disable SNMPv2c on the device to be polled.
Stackable Yes. For SAM 6.2 and higher. Two polling engines can be installed on a single server.
Pollers
Available?
For more information about licensing, see Why are you licensing by monitors instead
of by servers?
WAN and/or Minimal monitoring traffic is sent between the primary SAM server and any APEs that
Bandwidth are connected over a WAN. Most traffic related to monitoring is between an APE and
Considerations the SolarWinds database. Bandwidth requirements depend on the size of the
relevant component monitor. Based on 67.5 kB / WMI poll and a 5 minute polling
frequency, the estimate is 1.2 Mbps for 700 component monitors. For more
information, see How do SNMP and WMI polling compare?
74
SAM licensing model detailed
The SolarWinds SAM license you purchase is based on the number of allowed assigned component
monitors. A component monitor provides a statistic that you want to monitor in SolarWinds SAM. You can
have as many application templates and assigned monitors as you need, as long as the number of
assigned component monitors does not exceed the license count.
If you have more assigned component monitors than allowed by your license, the monitors that exceed
your license limit are not activated, and their component statuses are changed to "Not Licensed." You can
either disable some assigned component monitors to reduce your total assigned monitor count, or contact
SolarWinds about upgrading your SolarWinds SAM license.
75
Asset Inventory data collection
Asset Inventory data collection does not count against your SAM component monitor license.
Agents
Agent software is free. You remain bound by the limits of the license you own regardless of how you poll
information, either via an agent or another protocol.
When using AppInsight for SQL, 50 component monitors count against your licensed number of
component monitors, per SQL instance.
When using AppInsight for Exchange, 50 component monitors count against your licensed number of
component monitors, per Exchange Server.
Important: The example below illustrates a situation where you would have 40 available component
monitors available, but have surpassed your allowed number of 300 monitors by 60. The
discrepancy is caused by AppInsight application implementations. AppInsight applications are
licensed as 50 monitors per application and cannot be partially licensed, as is the case with typical
applications.
SolarWinds SAM licenses do not have to mirror the license count of any other installed SolarWinds
product. For example, you can install SolarWinds SAM with a 150 component license on a
SolarWinds NPM server with an unlimited node license.
76
See the available component monitors remaining in your license
Licensing Information
n When using your Customer ID and password, you can use your individual profile information.
n You can get your license information from the customer portal using the customer portal link:
https://customerportal.solarwinds.com/ instead of support.solarwinds.com
n If you do not know your CustomerID and/or password, navigate to
http://www.solarwinds.com/support/ticket/serviceticket.aspx and request the desired information.
n To get your activation key, navigate to the Customer Portal and click License Management, then click
the plus sign [+].
Deactivation
If you have deactivation information, you should step through the deactivation process a second time. You
no longer need your Customer ID and password. You will prompted multiple times to confirm that you are
sure you want to deactivate your product.
License Paths
The License Manager only works for people under active maintenance and can be downloaded from the
customer portal. You can activate or deactivate your products using the License Manager, as well as see all
products you have installed on that computer.
n Confirm that you have designated a SQL Server database instance for SolarWinds SAM.
Notes:
n If you are using an existing database or SQL account, the user account needs only to be in the
db_owner database role for the existing database.
n Confirm that the IIS Manager is not open while the Configuration Wizard is running.
n Know the SQL Server instance, and credentials, you want to use to store network data.
Note: The selected instance must support mixed mode or SQL authentication with strong passwords.
A strong password must meet at least three of the following four criteria:
n At least one uppercase and lowercase letter, one number, and one non-alphanumeric
character, #, %, or ^.
n If you are using SQL Express, specify your instance as local and use a strong password.
77
n If you are creating a new database, the user account must be a member of the dbcreator server role.
The sysadmin role and the sa user account are always members of dbcreator.
n If you are creating a new SQL account for use with SolarWinds SAM, the user account must be a
member of the securityadmin server role.
Note: The sysadmin role and the system administrator user account are always members of
securityadmin.
SolarWinds recommends that you perform upgrades during off-peak hours of network usage to
minimize the impact of temporary polling stoppage.
1. Click Start > All Programs > SolarWinds Orion > Configuration and Auto-Discovery > Configuration
Wizard.
2. Click Next on the Welcome window of the Configuration Wizard and complete the wizard as
instructed. If prompted to stop services, click Yes.
3. When prompted, specify both the port through which you want to access the web console and the
volume and folder in which you want to install the web console files.
Notes: If you specify any port other than 80, you must include that port in the URL used to access the
web console. For example, if you specify an IP address of 192.168.0.3 and port 8080, the URL used to
access the web console is http://192.168.0.3:8080. By default, you can log in with User Name
Admin and no password.
4. When complete, if you have not discovered your network devices and added them to the Orion
database, the Network Discovery Wizard starts.
78
Install, upgrade, and move SolarWinds Server &
Application Monitor
Before your installation, you need the following information to successfully complete the wizard:
1. Using an account with local administrative privileges, log in to the SolarWinds server on which you
want to install SolarWinds SAM and launch the SolarWinds executable.
Note: To avoid permissions issues, this account should not be a domain account, and it should not
be subject to any local or group policy restrictions.
2. Start the wizard and install all required components if prompted.
3. Complete the wizard as instructed. When complete, navigate to Hostname/Orion in your web
browser. You should see the Login screen.
4. Enter Admin in the User Name field (leaving the Password field empty) and then click Login.
79
7. Delete the following:
n The SolarWinds folder from the Program Files folder on your main volume. Typically, the
Program Files folder is located at C:\Program Files\.
n The SolarWinds folder from the Program Files\Common Files folder on your main volume.
Typically, the Common Files folder is located at C:\Program Files\Common Files\.
n The SolarWinds website directory. Typically, the SolarWinds website directory is located in
C:\Inetpub\.
n The SolarWinds folder from the All Users\Application Data\ directory. Typically, this
SolarWinds folder is located in C:\Documents and Settings\All
Users\Application Data\.
n Using your SQL Server tools, delete your Orion database. The Orion database is typically
named NetPerfMon, and it can be found in the Databases folder of your SQL Server
management application.
n Using your SQL Server tools, delete your Orion database user. The Orion database user can
be found by expanding Security > Logins in your SQL Server management application.
80
Administer and implement SAM technologies
SAM offers the following technologies and features:
To access the administrator functions, click Settings in the top right of Orion Web Console views.
1. Launch the Orion Web Console using either of the following methods:
n Start Orion Web Console in your SolarWinds Orion program folder.
n Launch a browser and enter http://ip_address or http://hostname, where ip_address
is the IP address of your SolarWinds Orion server, or where hostname is the domain name of
your SolarWinds Orion server.
81
2. Enter the user name and password, and click Login.
Until you set a password, you can log in as Admin with no password. After your first login,
change the Admin password. See Change account passwords.
My Dashboards
My Dashboards provide menu bars with shortcuts to Orion Web Console views. The default menu bars
include Home, and a menu bar for each installed Orion Platform product.
You can customize views and labels offered in default menus for individual users.
82
If you do not need to see all items in menu bars, and prefer navigating to display items in a menu
bar, click My Dashboards > Collapse.
Customize My Dashboards
Menu bars available in My Dashboards depend on the settings in your user account.
1. Find out which menu bar is assigned to Home, Network, or other product-specific tab for your user.
See Specify My Dashboard menu bars for users.
2. Add an Orion Web Console view or an external web page to the menu bar. The change will concern
all users who access the menu bar from My Dashboards. See Add items to My Dashboards.
To add a link to a details view for an important device, go to the view, copy the URL, and add it
as an extra item to the view.
3. To provide access to a specific set of links for specific users, create a menu bar, add the links and
assign the menu bar as the Home tab for the user(s).
The items users see in My Dashboards and in Alerts & Activity are specified in their user accounts.
Improve performance by setting the Home Page View to a view with a limited number of resources
on it.
83
4. Scroll down to Default Menu Bars and Views, and select top menu bars from the lists.
5. Select Yes for the items the user will see in the Alerts & Activity menu bar.
6. Select an item and use the arrows to change the order of menu bars. Select an item from the list to
specify the default Home page view.
The user can now use the specified links in My Dashboards and Alerts & Activity menu bars.
84
3. Drag available items from the left-hand column to Selected Items on the right.
You can also add links to node details views for specific nodes, or to external Internet pages
as a menu item.
a. Click Add below the Available items list, provide a name, URL and description for the
menu item, and click add.
b. Drag the new item to the Selected items column.
When you have a list of items you want users to access from My Dashboards, create a menu bar.
85
5. Click Submit.
The new menu bar is created. You can now assign it to users who will see the items in My Dashboards.
As you navigate Orion Web Console views, you can use breadcrumbs to the pick other views that are on the
same or higher navigational level as your current view.
You cannot view breadcrumbs in wizards, dashboards, or full-page resources such as All Active Alerts.
Only the first 50 monitored nodes, listed in alphanumeric order by IP address, are displayed.
86
Customize breadcrumbs
1. Click > at an appropriate level in the breadcrumbs to open the drop-down.
2. Click Customize This List.
3. Select an option from the menu, and click Submit.
All items in the customized list will be identical for the selected criterion.
Customize resources
Several resources that may be selected from the Add Resources page require additional configuration.
Network maps created with Network Atlas can give a quick overview of your network. Add a Network Atlas
map on a view.
1. Open a view where you want to add the map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Map, and click Add Selected Resources.
5. Click Preview to preview the map, and click Edit to customize the resource.
6. Select a map.
7. Specify the Zoom percentage at which you want to display the map.
If you leave the Zoom field blank, the map displays at full scale, based on the size of the
column in which the map displays.
1. Open the view where you want to add the list of objects on a map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select List of Objects on Network Map, and click Add Selected Resources.
5. Click Preview to preview the map, and click Edit to customize the resource.
6. Select a network map from the list of maps, and click Submit.
The view will now include a resource listing objects on the selected map.
87
Display a custom list of available maps
1. Open the view where you want to add the list of maps, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Custom List of All Maps, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Select maps you want to include in your maps list.
7. Click Submit.
The worldwide map provides a quick geographical overview of your network at any level from global down
to street.
The worldwide map provides a quick geographical overview of your network at any level from global down
to street.
1. Open the view where you want to add the Worldwide Map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Worldwide Map, and click Add Selected Resources.
5. Click Preview, and if the map looks correct, click Done.
You have now added the Worldwide map to the view. Customize the world map now.
1. Open the view where you want to add the events summary, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter event in the Search box, and click Search.
88
4. Select Event Summary, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Select the time period for displaying events in Time Period.
7. Click Submit.
You can copy URLs of external websites or customized views from preview pages, and copy them to the
User Links resource.
1. Open the view where you want to add the links resource, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter links in the Search box, and click Search.
4. Select User Links, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Enter the following information for each link you want to define:
a. A link Name and the URL of your link.
b. If you want your links to open in a new browser window, select Open in New Window.
Https URLs are not supported.
When you have static information that you want to provide in the Orion Web Console, add the Custom
HTML resource on a view. This resource can also provide quick access to customized views.
1. Open the view where you want to add the custom resource, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter html in the Search box, and click Search.
4. Select Custom HTML, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
6. Enter HTML formatted content as required.
7. Click Submit.
Filter nodes
The Orion Web Console can maintain a customizable node list for your network. Node lists can be
configured for specific views using SQL query filters.
1. Open the view where you want to add the node list, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter nodes in the Search box, and click Search.
4. Select All Nodes - Table, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
89
6. To filter your node list by text or IP address range, provide the text or IP address range by which you
want to filter your node list in the Filter Text field:
n Type Home in the Filter Text field to list all nodes with "Home" in the node name or as a
location.
n Type 192.168.1.* in the Filter Text field to list all nodes in the 192.168.1.0-255 IP address
range.
7. Select the property for the filter text provided above:
n If you typed Home in the Filter Text area, select Node Name or Location to list nodes with
"Home" in the node name or as a location.
n If you typed 192.168.1.* in the Filter Text area, select IP Address to list only nodes in the
192.168.1.0-255 IP address range.
8. To apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes (SQL) field.
By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so ORDER BY clauses included in SQL
filters are redundant and will result in Custom SQL filter formatting errors.
The Orion Web Console can maintain a customizable node list for your network. Node lists can be
configured for specific views with node grouping.
1. Open the view where you want to add the node list, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter nodes in the Search box, and click Search.
4. Select All Nodes - Tree, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
6. Select up to three criteria, in specified levels, for Grouping Nodes within your web console view.
7. Select whether you want to put nodes with null values In the [Unknown] Group or ungrouped At the
Bottom of the List.
8. To apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes (SQL) field.
By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so ORDER BY clauses included in SQL
filters are redundant and will result in Custom SQL filter formatting errors.
The Orion Web Console can display a service level agreement (SLA) line on any Min/Max/Average bps
chart. When you add a customer property named "SLA" and populate the field with your device SLA values,
the Orion Web Console displays the appropriate line on your charts.
90
n The SLA line may not appear immediately. It may take several minutes for the change to be
detected by the Orion Web Console.
Browse to the Interface Details view of one of the interfaces you edited. The SLA line displays on any chart
showing Min/Max/Average bps.
When you are managing or monitoring large numbers of network devices, node list resources can easily
become very large and difficult to navigate. Filters are optional SQL queries that are used to limit node list
displays for easier resource navigation. SQL queries can be made on any predefined or custom properties.
For more information about defining custom properties, see Create a custom property.
If you have upgraded to Orion Platform version 2015.1.x or later, your custom SQL or SWQL query or
filter may no longer work correctly. For a list of database changes from Orion Platform version
2014.2 to version 2016.1, including new tables, column changes, or data constraint or data type
changes, see the Database Changes spreadsheet.
By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so order by clauses included in SQL filters
are redundant and will result in Custom SQL filter formatting errors.
91
n Filter the results to only show nodes that are not Up:
Status<>1
The following are valid status levels:
o 0 = Unknown (current up/down status of the node is unknown)
o 1 = Up (The node is responding to PINGs)
o 2 = Down (The node is not responding)
o 3 = Warning (The node may be responding, but the connection from the server to the Node is
dropping packets)
l Only show Cisco devices: Vendor = 'Cisco'
l Only show devices in Atlanta. (using a custom property named City):
City = 'Atlanta'
l Only show devices beginning with "AX3-": Caption Like 'AX3-*'
l Only show Nortel devices that are Down:
Vendor Like 'Nortel*' AND Status=2
l Only show devices ending in '-TX':
Vendor Like '*-TX'
Custom Object resources can display performance data for any monitored objects.
You can graph data for multiple objects on the same chart, such as memory usage on all storage devices.
The resource can include a sum of all the series.
c. Select objects (either a group, or expand a group and select individual child objects), and click
the green arrow ( ) to move the objects into the pane on the right.
d. Click Submit.
The selected objects will appear on the Edit Custom Object Resource page, together with
appropriate options.
5. Select a Chart to include in your custom object resource.
6. If you want to automatically display nodes related to the current view, select the option in Select
Object.
7. To limit the number of data series in the resource, select Limit Series, and select the number of
series to allow.
8. Select whether or not you want to Show Sum in Data Series.
92
9. Select the Time Period and Sample Interval.
10. To automatically hide the resource when there is no data for it to report, select Yes for the Auto-Hide
Resource option.
11. Click Submit.
Use the customization options available in the chart to customize the data, layout and time frame shown
by the chart.
Some charts have drop-down menus that include the following options:
n View chart data over the Last 7 Days or over the Last 30 Days
n Select Edit Chart or click on the chart to open the chart resort in a new tab.
n View Chart Data as an HTML format document
n View Chart Data in Excel to see chart data in an Excel™-compatible format
If a chart has an Edit button, click it to get to the Edit Resource page. Edit titles, time periods, or other
details, and click Submit to go back to the view and see the changes applied in the chart.
You can customize the title and subtitle for the resource and for the chart.
To change the chart labels, click Advanced, and enter a text or variable that displays as the chart title
or subtitle.
The default for the chart subtitle is ${ZoomRange], which shows the selected zoom range.
Select the box to display a trend line on the graph. This shows potential future results as
extrapolated from collected historical data.
The trend lines are intended only as approximate predictions of future data.
Select the box if you want to display the sum of all data series in the form of stacked bars or
lines.
93
Calculated Series: Show the 95th percentile line
Select the box to show the 95th percentile line. This is a well-known statistical standard used
to discard maximum spikes, based on 5 minute data samples. The calculation gathers these
values every 5 minutes for however long you select, throwing away the top 5% so as to yield the
95th percentile value.
Enter the highest number of items you want to display in this chart.
Select the default range of data to be displayed from the drop-down list.
Select the amount of historical data to load from the drop-down list.
Select the sample interval to be used from the drop-down list. Each sample interval is represented
on a chart by a single point or bar. Data within a selected sample interval is summarized
automatically.
Click Export or click the chart to open the Custom Chart page in a new tab. You can change the chart
settings and click Refresh to see the changes applied in the same tab.
If the chart has a drop-down menu, you can also access the custom chart page by selecting the Edit
chart option.
Select the time period that you want the chart to cover.
Alternatively, you can enter a specific time period for the chart.
Enter the start date and time for the chart in one of the formats shown. If you do not enter a time,
this will default to 12:00:00 AM.
Enter the end date and time for the chart in one of the formats shown. If you do not enter a time,
this will default to 12:00:00 AM.
94
Sample Interval
Select the sample interval. Each sample interval is represented on a chart by a single point or bar.
Data within a selected sample interval is summarized automatically.
Chart Size: Width
Enter a custom width, in pixels, for this chart. The default is 640.
Enter a custom height, in pixels, for this chart. Enter 0 to maintain the original width/height ratio.
Font Size
Select the font size for the chart from the drop-down list.
Select the box to display a trend line on the graph. This shows potential future results as
extrapolated from collected historical data.
Due to the broad array of factors that can affect the performance of devices, trend lines are
intended as approximate predictions of future data only.
Click to display or save the data being used in this report as an xls file.
Click to display the data in this report as a HTML table in the web browser.
Customize views
Orion Web Console views are configurable presentations of network information that can include maps,
charts, summary lists, reports, events, and links to other resources.
Customized views can be assigned to menu bars. With NOC View Mode enabled, views may be optimized
for display in Network Operations Centers.
To make views and graphs larger for larger screens, resize the columns dynamically (drag the
division bars) and use your browser zoom controls, such as <Ctrl>+<+> in Chrome.
Create views
You can customize the Orion Web Console for individual users by creating views.
95
OPTION ACTION
Select the appropriate object type, such as nodes, interfaces,
Identify objects to see on the view.
groups, applications, and so on.
Access the view from the Menu Bar. Add the view into the menu bar.
Create views
1. Log in to the Orion Web Console, and click Settings > All Settings.
2. Click Add New View in the Views grouping.
3. Name the view, and select the view type.
You have now created an empty view. The Customize view page opens automatically. Add resources that
contain the information you want to see.
The Type of View affects how the view is made accessible to users, and your choice may not be
changed later. For more information, see Specify views for device types.
After you have created a new view, the Customize page opens. For more information, see Add resources
and columns to views, and define subviews.
96
Add resources and columns to views, and define subviews
Administrators can edit views on the Customize page for the view. Click Customize Page on the view, or
access the page through Manage Views.
1. On the Customize page, click + next to the column that you want to add the resources.
To open the Customize view page, click Settings > All Settings > Manage Views. Select the view,
and click Edit.
97
2. Select resources in the middle pane, and click Add Selected Resources.
You can limit offered resources by criteria in the Group by list, or search for a resource in the
Search box.
98
3. Use the arrow icons next to the columns to move resources between columns.
n Resources already in your view are not marked in the list. You can add a resource on a view
more than once.
n Some resources may require additional configuration.
n Several options on the Add Resources page are added to the list of resources for a page, but
the actual configuration of a given map, link, or code is not added until the page is previewed.
Add columns
99
You do not have to add resources here. You can click Done, and drag resources between the
columns on the view.
To change a column width, position the cursor between the columns and drag the column border to
achieve the appropriate width.
To move resources within a column or between columns on a subview, drag the handle at the top of the
resource to the new location.
If there is too much information on the view, group and divide resources into subviews.
To open the Customize view page, click Settings > All Settings > Manage Views. Select the view,
and click Edit.
100
2. Click Add Tab.
3. Type a name for the new tab, and click Update.
4. Select an icon, and add resources.
101
5. Click Done.
To save space on the views, click the double arrow button to minimize subviews.
When you are done with your changes, click Preview, and then click Submit.
102
Creating a Custom Summary View
The Orion Custom Summary View enables you to create a fully customized object-based view composed
solely of resources you have selected. The following procedure creates a custom summary view in the web
console.
Note: For more information about customizing available resource types, click Help in the header of any
resource on the Custom Summary view, and then click the corresponding resource type.
You can select any external website and add it to the Orion Web Console as a view.
1. Log in to the Orion Web Console and click Settings > All Settings in the menu bar.
2. In the Customize Navigation & Look grouping, click External Websites.
3. Click Add.
4. Provide a Menu Title. This will be used for the website in the My Dashboards menu bar.
5. If you want to include a heading for the view, provide an optional Page Title.
6. Provide the URL of the external website, in http://domain_name format.
7. Select the Menu Bar to which you want to add the website link.
See My Dashboards.
If you select Admin as the menu bar, the website will be available from My Dashboards >
Home for administrators.
103
Optimize views for TV screens or mobile devices
A Network Operations Center (NOC) view provides a single page view of critical statistics that can fit on a
TV screen or a mobile device. If you define multiple subviews, they rotate automatically on the screen, each
subview available as a separate slide.
Headers and footers are compressed in NOC views, increasing the available space to display resources.
To get a direct link to a NOC view, use the Link to NOC View link.
You will return to the default view with the full header, footer and left navigation.
Manage NOC Views
You can display a list of all NOC views defined in your Orion to get a better understanding of your NOC
views. From the NOC views list, you can easily add, edit or manage your NOC views.
You can view NOC views from any view. Click Customize Page, and click List of created
NOC views in the NOC view section.
Display subviews
If more subviews are defined for the view, you can see white circles in the top right corner. The currently
104
active tab is displayed in orange.
1. Click the Settings icon in the top right corner of the NOC view, and select Enable Drag&Drop / Pause.
2. Drag and drop resources within the selected pane.
3. When you have finished repositioning the resources, click the Settings icon again, and select Disable
Drag&Drop / Resume.
Logo requirements:
1. If you already are in a NOC view, click the NOC Settings icon and select Customize NOC View Logo.
2. To hide the logo, clear the NOC View Logo option.
3. To change the logo:
a. Make sure that NOC View Logo is selected.
b. Click the Browse button for NOC View Logo and navigate to the appropriate logo image.
By default, the SolarWinds logo is used on NOC views. It is available as SW_NOClogo.png in
/NetPerfMon/images on your Orion server.
4. Click Submit to apply your changes in the view.
As a security feature, administrators can limit which devices are displayed on a view.
1. Click Settings > All Settings in the menu bar, and click Manage Views in the Views grouping.
2. Select a view, and click Edit.
You can also open the Customize View page from the view, by clicking Customize Page.
3. On the Customize View page, click Edit in the View Limitation area.
105
4. Select the type of view limitation you want to apply, and click Continue.
5. Provide or select strings or options to define the device types that you want to include or exclude
from the selected view, and click Submit.
The asterisk (*) is a valid wildcard. Pattern limitations restrict views to devices for which the
corresponding fields include the provided string.
Copy views
When you want to create multiple views based on the same device type, create one view, and use it as a
template to create other new views.
Delete views
In the Orion Web Console, you can specify views displayed for each type of device you have on your
network, such as routers, firewalls, or servers.
106
3. Select a Web View for the individual types of devices currently monitored on your network.
4. Click Submit.
When you click a device now, the view specified for the device type will be displayed.
Many views in the Orion Web Console can be exported to portable document format (.pdf).
The Export to PDF feature requires IIS Anonymous Access. Confirm that the IUSR_SERVERNAME user
is in the local Users group on your Orion server.
1. Open a view, and click Export to PDF in the top right corner of the view.
2. If you are prompted to save the .pdf file, click Save.
3. Navigate to a location, provide a file name, and click Save.
The Web Console Settings page allows an Orion Web Console administrator to customize the Orion Web
Console user environment.
Session Timeout
Provide the amount of time, in minutes, that Orion Web Console waits through user inactivity before
the user is logged out.
Select whether you want to enable or disable automatic login with Windows Active Directory
Credentials. With this feature enabled, the user can log in automatically.
Page Refresh
Specify the amount of time that passes before an Orion Web Console view reloads automatically
107
Site Logo
Select the box, and provide a path to a banner graphic that appears at the top of every Orion Web
Console page. See Change the Orion Web Console logo.
NOC View Logo
Select the box, and provide a path to a banner graphic that appears at the top of every NOC view.
Provide a text all Orion Web Console users will see before they log in. Fill in up to 3500 characters.
HTML tags are allowed.
Help Server
Provide the URL of the server where online help for Orion Platform products is stored. The default
location is http://www.solarwinds.com.
If you are in an Internet-restricted network environment but require access to online help,
download the entire online help, copy it to a web server, and change the Help Server URL to
that of the web server. You can download the online help from the documentation page for
your product at https://support.solarwinds.com/Success_Center.
Specify how the availability status of nodes in node trees or on maps is displayed in the Orion Web
Console.
n Mixed Status shows Warning ensures that the status of a node group displays the worst
warning-type state in the group. If none of the group members have a warning-typed state but
the group contains both up and down nodes, a Mixed Availability warning state is displayed for
the whole group.
Examples:
Critical + Down = Critical,
Critical + Warning = Critical,
Up + Down = Mixed Availability.
n Show Worst Status ensures the worst state in a node group is displayed for the whole group.
Examples:
Up + Down = Down
Unreachable + Shutdown = Shutdown.
108
Child Status Rollup Mode
Specify how the status of any single node on the node tree or on a map is displayed.
n Select Show Worst Status to ensure that the worst status of the node group is displayed for the
whole group (e.g. red if any of the nodes are down).
n Select Show Worst Status (Interfaces only) to ensure that the worst status of any of the
interfaces on a selected node is displayed. Only if you have SolarWinds NPM installed.
n Select Show Worst Status (Applications only) to ensure that the worst status of any of the
applications on a selected node is displayed.
n Select Show only ICMP Status to only display up/down status for monitored interfaces.
Select whether you want to use a static or blinking icon to display the status of the children of any
single node on the node tree or on a map. By default, Orion uses a static icon to display the status of
child objects.
Integration Tips
Specify whether you want to show or hide the list of products in the How SolarWinds Products Work
Together section of the Settings page.
Auditing settings
Select Enable Audit Trails to keep a record of all actions taken by Orion Web Console users. Depending on
the number of technicians or the activity level of your installation, this may increase the storage needs of
your database.
Chart settings
Chart Aspect Ratio is the height/width ratio for web console charts. This ratio should be set between
0.25 and 3.0 to avoid erratic display problems, though the performance of individual systems may
differ.
95th Percentile Calculations adds annotation lines to charts at the entered percentile. This value is
normally set to 95. See 95th Percentile Calculations.
109
Maximum Number of Data Series Displayed on Chart
The Maximum Number of Data Series Displayed on Chart setting determines the maximum number
of data series that will display on a chart at the same time. The default value for this setting is 10.
The actual data points that are used to create a chart may be shown by checking Show Data Points
on Lines.
Font Size
Font Size sets the default relative size, Small, Medium, or Large, of the text that is displayed within
charts in the Orion Web Console. This setting is independent of your browser settings. The font
settings in your browser will affect resource headers and some resource contents.
Select the box if you want to be notified when removable volumes are added to your network and
discovered during network discovery.
You should configure the default send email action to receive notifications.
See Discover and add network devices.
Automatic Geolocation
Select how frequently you want the active alerts resource to refresh. Any alerts that trigger within the
refresh interval appear when the grid refreshes.
Administrative functions
Sensitive network information, such as community strings, logins, and passwords, is not viewable in the
Orion Web Console.
If you have secured your network, you can display secure data in the Orion Web Console.
110
This setting does not affect the display of custom reports that you export to the web. See Creating
Reports in the Web Console.
Specify a method that decides what happens if a polled value is less than the previous polled value.
Orion Platform products are capable of handling either 32-bit or 64-bit counters.
Orion fully supports the use of 64-bit counters, but these counters can exhibit erratic
behavior in some implementations. If you notice peculiar results, disable the use of 64-
bit counters for the problem device, and contact the device manufacturer.
If your SolarWinds Orion server does not have Internet access, you can use a proxy server to allow the
Orion server to connect to certain pages and websites. Use a proxy server to:
111
112
To configure web proxy settings:
1. In the Orion Web Console, click Settings > All Settings > Product specific settings > Proxy Settings.
2. Select Use the following settings, and specify the IP address and port number of the proxy server.
3. If the proxy server requires authentication, select the check box, and specify the user name and
password.
4. Enter a URL, and click Test connection to verify that you can reach the destination address through
the proxy.
5. Click Save.
Manage Users
Manage Orion Web Console user accounts
Users need an Orion Web Console account to perform actions in your SolarWinds product, such as
acknowledging alerts. Default account views and privileges are assigned in the account manager.
You may not need to grant all users accounts if they only need to review reports or access views. See Share
views with non-Orion Web Console users for more information.
Add users individually, add group accounts, or use Active Directory accounts. If a user is in multiple group
accounts, the permissions of the group highest on the Groups tab of the Account Manager are applied to
the user. By default SolarWinds uses MSAPI to authenticate Active Directory users, but you can
authenticate users with LDAP.
To prevent issues with accounts, make sure that your SQL Server does not have the no count
connection option enabled.
Create users
Before you begin, consider what tasks the user must perform, and what views and menu bars are most
suitable.
Users created using default settings can log in to the Orion Web Console and see information available in
views, resources, and reports. For administration and customization tasks, users need extra rights.
ACCESS
TASK
(SELECT YES FOR THIS OPTION OR DO AS INSTRUCTED)
113
ACCESS
TASK
(SELECT YES FOR THIS OPTION OR DO AS INSTRUCTED)
Add, edit, schedule, and delete reports. Allow Report Management Rights
Add, edit, and delete alerts. To only allow some actions, keep No in Allow Alert
Management rights and Allow items in the Alerts
section as appropriate.
1. Log in to the Orion Web Console, and click Settings > All Settings.
2. Click Manage Accounts in the User Accounts grouping, and click Add New Account on the Individual
Accounts tab.
114
Create users based on existing Active Directory or local domain accounts
Users can use their existing Active Directory credentials to log in to the Orion Web Console, so you do not
need to manage an extra user account.
n You must enable Windows Account Login in the Orion Web Console.
1. Click Settings > All Settings, and in Product Specific Settings, click Web Console Settings.
2. In Windows Account Login, select Enable automatic login, and click Submit.
n To maintain administrative privileges, individual and group Windows user accounts must be
defined in the same domain as the SolarWinds server they can access.
n Only Security AD groups are supported. Distribution Groups are not supported.
1. Log in to Orion Web Console, and click Settings > All Settings.
2. Click Manage Accounts in the User Accounts grouping, and click Add New Account.
3. Select Windows individual account or Windows group account, and click Next.
4. Provide the credentials for an account with administrative access to the Active Directory or local
domain, and click Next.
115
5. If a system account is available, you can use it. Select Use [Account Name] account to access Active
Directory or Local Domain, and click Test Active Directory.
6. To specify the credentials manually, select Specify credentials to access the Active Directory or Local
Domain, and provide the credentials.
7. Search for the Active Directory or local domain account.
To search for all users or groups in the domain, enter domain name\* and click Search.
8. Select the appropriate users in the Add Users area, and click Next.
9. On Define Settings, provide rights so that the user can perform assigned tasks, select default views
and menu bars, and then click Submit.
Users can now log in to the Orion Web Console using their local domain or Active Directory credentials.
If you use Active Directory, users can also automatically login with their Windows credentials.
When you Server & Application Monitor Getting Network Performance Monitor Getting
log in to the Started Guide Started Guide
Orion Web User accounts User accounts
Console for How user accounts work How user accounts work
the first time, Create a user Create a user
SolarWinds Enable Active Directory Windows Use Active Directory credentials
recommends authentication for users
that you Change account passwords Change account passwords
change the
password for the Admin account.
1. Log in to the Orion Web Console, and click Settings > All Settings.
2. Click Manage Accounts in the User Accounts grouping.
116
3. Select a user, and click Change Password.
4. Enter and confirm the new password, and click Change Password.
You can choose to have all of your AD users authenticate through LDAP. The SolarWinds Orion server does
not need to be added to the Windows domain with this authentication method.
Click Discover DN to fill in the distinguished name (DN) of the AD domain automatically. If the
DN field does not populate, verify that the Directory Server Address is correct.
Windows individual accounts now use LDAP. If you created Orion Web Console accounts that use Active
Directory or local accounts and those accounts cannot authenticate through LDAP, those accounts cannot
login.
If you disable this selection, Windows users or group members created while it was enabled cannot login.
Each user or group account can have different privileges applied to it, such as the ability to modify alert
definitions or delete nodes.
117
5. Specify the login options.
118
6. Specify what tasks the user should be able to do.
ACCESS
TASK
(SELECT YES FOR THIS OPTION OR DO AS INSTRUCTED)
Acknowledge and clear events, advanced Allow Account to Clear Events, Acknowledge Alerts and
alerts, and Syslogs. Syslogs.
7. If you want the user to use additional browser functions, such as right-click menu options, set Allow
Browser Integration to Yes.
Right-click menu options also depend on installing the SolarWinds Desktop Toolset and
running the Toolset Integration Tray application on each client computer.
New account settings are applied when a user next logs in.
The user account also controls the default menu bars and views, and how much of your network they can
access through the Orion Web Console.
119
Set default menu bars and views for users
The items users see in My Dashboards and in Alerts & Activity are specified in their user accounts.
Improve performance by setting the Home Page View to a view with a limited number of resources
on it.
5. Select Yes for the items the user will see in the Alerts & Activity menu bar.
6. Select an item and use the arrows to change the order of menu bars. Select an item from the list to
specify the default Home page view.
The user can now use the specified links in My Dashboards and Alerts & Activity menu bars.
New account settings are applied when a user next logs in.
120
You can set default view for feature-specific views, such as hardware health or F5, or for product-specific
view, such as VSAN or Application Details.
Account limitations ensure that Orion Web Console users only view the network objects that are relevant to
their job duties.
Predefined account limitations use built-in SolarWinds Orion properties to limit user access. For greater
flexibility, you can create your own account limitations in the Account Limitation Builder, based on custom
properties.
Account limitations restrict user access to specific network areas or withhold certain types of information
from designated users.
To limit user access, apply a limitation on the user account, and specify the network area the user can
access. Depending on the limitation, you can use logical operators and wildcards.
Pattern limitations can have a negative impact on performance and are error prone.
If the default limitations are not enough, you can create limitations based on custom properties, and
apply them on user accounts.
n Group limitations are not applied until after the group availability is calculated.
n Because SolarWinds NetFlow Traffic Analyzer (NTA) initially caches account limitations, it may
take up to a minute for account limitations to take effect in SolarWinds NTA.
When the user logs back in, the account respects the limitations applied to it.
121
Patterns for limitations
When restricting user access to network areas, you can specify the limitation with patterns using OR, AND,
EXCEPT, and NOT operators with _ and * as wildcards if the limitation allows pattern matching.
You may also group operators using parentheses, as in the following example.
(*foo* EXCEPT *b*) AND (*all* OR *sea*) matches seafood and footfall, but not football
or Bigfoot.
You can define the part of a monitored network that users can access based on custom properties, and
create custom limitations. Custom limitations are added to the list of available limitation types that you can
apply on individual user accounts. After you create the limitation, you must edit accounts to use the
limitation, and then select how the account is restricted.
n Before you start, plan how you want to limit the user access, and create custom properties.
n This procedure requires access to the computer that hosts the SolarWinds Orion server.
1. Click Start > All Programs > SolarWinds Orion > Grouping and Access Control > Account Limitation
Builder.
2. Click Start on the splash screen.
3. Click Add Limitation.
4. Select a Custom Property. The fields are populated automatically based on your selection.
5. Choose a Selection Method.
This is the selection format that will appear when you are choosing values for the account
limitation in the Orion Web Console.
Pattern matching is the most powerful selection, but it is also the selection most prone to
errors when restricting access and impacts performance.
Your account limitation is added to the top of the table view. You may now apply the limitation on user
accounts to restrict user access to monitored objects in the Orion Web Console.
Deleting a limitation makes it unavailable for future use in the Orion Web Console. If the limitation is
applied to user accounts, the accounts will remain limited.
This procedure requires access to the computer that hosts the SolarWinds Orion server.
1. Start the Account Limitation Builder in the SolarWinds Orion > Grouping and Access Control program
folder.
122
2. Click Start on the splash screen.
3. Click the row of the limitation that you want to delete.
The limitation is now unavailable for limiting user accounts in the Orion Web Console.
You can log in automatically to the Orion Web Console using any of the following methods.
Create users based on active directory or local domain accounts, and enable automatic login for
users logged in to the server. See Create users based on existing Active Directory or local domain
accounts.
Windows authentication must be enabled in the Configuration Wizard and the Web Console
Settings. See Enable Windows Authentication with Active Directory.
Users can be authenticated through Windows Security, with no need to log in with separate
credentials. For more information, see Log in with Windows pass-through security.
If the DirectLink account is active, any URL referring directly to an Orion Web Console page will
bypass the login page by logging the user into the DirectLink account. See Share views with non-
Orion Web Console users.
The Orion Web Console can authenticate Active Directory users and users who are members of Active
Directory security groups by using MSAPI or LDAP. By default, Windows individual or group accounts use
MSAPI to authenticate accounts.
123
You can only use one authentication protocol at a time. All Windows accounts are authenticated through
MSAPI or LDAP, depending on which one is enabled.
SolarWinds offers a free analyzer tool for Active Directory that provides instantaneous visibility into
effective permissions and access rights. The tool provides a complete hierarchical view of the
effective permissions access rights for a specific file folder (NTSF) or share drive. Download it for
free from here: http://www.solarwinds.com/products/freetools/permissions_analyzer_for_active_
directory/.
1. Enable the Orion Web Console to use automatic Windows Authentication.
a. Start the Configuration Wizard in the SolarWinds Orion > Configuration and Auto-Discovery
program folder.
b. Select Website, and click Next.
c. Provide the appropriate IP Address, Port, and Website Root Directory, and select Yes - Enable
Automatic Login Using Windows Authentication.
d. Click Next, and complete the Configuration Wizard.
2. Log in to the Orion Web Console using the appropriate domain and user, providing Domain\User
name or Username@Domain as the User Name.
3. Run the Configuration Wizard and enable Windows authentication.
4. Login to the Orion Web Console, and navigate to Settings > All Settings. In Web Console Settings,
select Enable automatic login in the Windows Account Login drop-down.
The following Active Directory login scenarios are supported for SolarWinds products using the latest
version of the Orion Platform.
124
NETWORK ATLAS AND
WEB CONSOLE LOCAL LOGIN UNMANAGE
SCENARIO
LOGIN SUPPORTED? REQUIRED? UTILITY LOGIN
SUPPORTED?
Login with trusted domain AD user
Notes:
1. Use a group account from the domain where the Orion Platform product server is located. This
group contains a user from the trusted domain. Log in with this user.
2. Use a group account from the domain where the Orion Platform product server is located. This
domain is trusted by the domain in which the Orion server is located. This group contains a user
from the domain of the Orion server. Log in with this user.
3. Active Directory authentication is performed by the web service. If you need to authenticate users
from an AD forest other the one to which your primary SolarWinds server belongs, you must have an
Additional Web Server in the AD forest wherein the users to be authenticated exist.
Enable LogonFallback
LogonFallback must be enabled when the Active Directory user of the Orion Web Console does not have
local login rights to the web server.
1. Locate the file web.config on the server hosting your Orion Web Console.
The default location is c:\inetpub\SolarWinds\.
2. Create a backup of web.config.
3. Locate row <add key="LogonFallback" value="false" />.
4. Set value="true".
125
5. Save web.config.
6. Restart your SolarWinds website in Internet Information Services Manager.
To authenticate users through Windows pass-through security, IIS NT Security must be enabled on your
server.
Pass-through security can be configured to employ Domain security, Local computer security, or both
Domain and Local computer security at the same time.
The Orion Platform account credentials must match the credentials used for the Domain or Local computer
security.
n This procedure requires access to the computer that hosts the SolarWinds Orion server.
n When authenticating users with Windows Security, ensure your Orion server uses the NetBIOS
domain name, instead of the fully qualified domain name.
1. If you are using NT Domain Authentication Format for pass-through accounts, create these pass-
through accounts in the Orion Web Console Account Manager using Domain\UserID as the User
Name. For example:
n Washington\Edward
n StLouis\Bill
2. If you are using Local Computer Authentication Format for pass-through accounts, create these
accounts in the Orion Web Console Account Manager using Computer\UserID as the User Name. For
example:
n SolarWindsS2\Edward
n Server3\JonesR
3. Start the Internet Information Services Manager, enable Windows Authentication for the SolarWinds
NetPerfMon website, and restart Internet Services.
Log in to the Orion Web Console using the Windows account credentials you have already established.
Any URL referring directly to a Orion Web Console page bypasses the login screen, logging the user into
the DirectLink account. If the DirectLink account does not exist, users are directed to the login page.
n The DirectLink account is created like any other account, and it can include custom views and
account limitations.
n If you embed a view in another website, you may need to either disable cross-frame (X-Frame)
protection in your IIS configuration, or add the website to the X-Frame-Options header in IIS.
SolarWinds enables cross-frame protection by default to decrease security risks. Consult
microsoft.com for more information.
126
1. Log in to the Orion Web Console as an administrator.
2. Click Settings > All Settings in the menu bar.
3. In the User Accounts grouping, click Manage Accounts.
4. Click Add New Account.
5. Type DirectLink as the User Name.
6. Type a Password, confirm it, and click Next.
7. Edit DirectLink account options. See Define what users can access and do.
8. Click Submit.
Users can now look at views without an account on the Orion Web Console.
Create a favorite or bookmark that includes your Orion individual account user name and password as
parameters within the URL.
HTTP requests are not encrypted, so account information sent in HTTP requests are not secure. For
more information about enabling HTTPS on your Orion Platform product server, consult
www.microsoft.com.
Create a favorite with a link in the following form to pass the login information:
http://DOMAIN/Orion/Login.aspx?AccountID=USER&Password=PASSWORD
Provide the hostname or IP address of your SolarWinds Orion server as the DOMAIN. Provide your Orion
user name as the USER, and then provide your Orion user account password as the PASSWORD.
127
Discover and add network devices
When you install your Orion Platform product, you must identify the devices you want to monitor, and add
them to the SolarWinds Orion database.
l To automatically discover and add a larger number of devices across your enterprise, use the
Network Sonar Discovery and Network Sonar Results Wizards.
l To add individual objects for monitoring, add single nodes using Node Management in the Orion
Web Console.
128
Discover your network with the Discovery Wizard
The first time you discover your network, SolarWinds recommends adding a limited number of edge
routers or switches, firewalls and load balancers (if you have them), and critical physical or virtual servers
and hosts.
1. If the Discovery Wizard does not start automatically after configuration, click Settings > Network
Discovery.
2. Click Add New Discovery, and then click Start.
3. On the Network panel, if this is your first discovery, add a limited number of IP addresses.
As you scale your implementation, you can use the following scanning options.
Option Description
Use this option when you want Orion to scan one or more IP ranges.
IP Ranges If you have many IP ranges to scan, consider adding multiple discovery jobs rather
than including all ranges in a single job.
129
4. If the Agents panel appears, you enabled the Quality of Experience (QoE) agent during installation.
The QoE agent monitors packet-level traffic. If there are any nodes using agents, select the Check all
existing nodes check box.
This setting ensures that any agents you deploy, including the one on your Orion server, are up-to-
date. If there are no nodes using agents, you can leave this option unchecked.
5. On the Virtualization panel, to discover VMware vCenter or ESX hosts on your network:
a. Check Poll for VMware, and click Add vCenter or ESX Credential.
b. Select <New credential> and provide required information.
If you do not add the host credentials, Orion still discovers the virtual machines (VMs) on
the host. However, you will not be able to see the relationships mapped between the
VMs and hosts.
130
6. On the SNMP panel:
a. If all devices on your network require only the default SNMPv1 and SNMPv2 public and
private community stings, click Next.
b. If any device on your network uses a community string other than public or private, or if you
want to use an SNMPv3 credential, click Add Credential and provide the required information.
7. On the Windows panel, to discover WMI or RPC-enabled Windows devices, click Add New Credential
and provide the required information.
SolarWinds recommends that you monitor Windows devices with WMI instead of SNMP.
131
8. On the Monitoring Settings panel, SolarWinds recommends manually setting up monitoring the first
time you run discovery. This allows you to review the list of discovered objects and select the ones
you want to monitor.
When you scale monitoring, you can configure discovery to automatically start monitoring objects it
finds.
Discovery can take anywhere from a few minutes to a few hours, depending on the number of
network elements the system discovers.
132
Add nodes using Active Directory
Query your Active Directory Domain Controller to add nodes quickly and efficiently. Your SolarWinds Orion
server can use the devices specified in AD instead of scanning every IP address in the subnet.
Create scheduled discoveries to discover and import any new servers and workstations that have
been added to AD automatically.
1. Click Settings > Network Discovery, and click Add New Discovery.
2. On Network Selection, click Add Active Directory Controller to query.
3. On the Add Active Directory DC pop-up, enter your domain controller’s IP address/hostname and
credentials, and click Next.
4. Select the organizational units (OUs) you want to scan for nodes, and click Finish.
By default, all OUs are selected, but only servers will be added. Add workstations by clearing
the Import servers only check box below the OUs.
On the Network Selection page, you will see the OUs you have added. You can add additional AD
controllers, or any other IP addresses that you need before continuing with discovery.
133
Credentials for Active Directory discovery
When you use Active Directory discovery to add nodes, you must provide the credentials of a Domain
Administrator user.
The credentials you provide are added to the discovery wizard as Windows credentials automatically.
If the Active Directory credentials are not same as the Windows credentials for monitoring the node, add
credentials for WMI monitoring in the Windows Credentials step.
134
Automatically add discovered nodes
Automatic monitoring means you do not have to go through the Discovery Import wizard every time you
run a discovery. It is useful when you have configured your discovery to find similar nodes or network
devices.
1. Click Settings > Network Discovery, and add a discovery, or select an existing one and click Edit.
2. Click through the Discovery Wizard to the Monitoring Settings page.
3. Choose to include devices that only respond to ICMP (ping). If you decide to exclude devices that only
respond to ICMP, your discovery list may be smaller than you expect and you must add those devices
manually.
4. On Monitor Settings, select Automatically monitor based on my, and click Define Monitoring Settings.
5. Select the interfaces properties you want to apply to any discovered nodes and click Next. You can
also create advanced filters for interfaces under Advanced selection options.
135
6. Choose the types of volumes you want to monitor.
136
Add discovered devices to SolarWinds NPM
Check out this video on running a network discovery and adding devices.
After the Network Sonar Wizard discovers your network, the Network Sonar Results Wizard opens, allowing
you to import network elements into SolarWinds NPM your SolarWinds product. Nodes that are discovered
do not count against your license count. Only nodes that you have added to the SolarWinds Orion
database count against your license.
When you manually run discovery, by default, the system automatically selects all network elements to be
monitored. You must clear the check boxes for elements you do not want monitored.
If you are discovering your network for the first time, SolarWinds recommends that you monitor a
small number of devices.
1. If the Network Sonar Results Wizard does not open automatically, click the Scheduled Discovery
Results tab, select nodes you want to monitor, and then click Import Nodes.
2. Ensure the device types you want to monitor are selected, and click Next.
If a device appears as unknown vendor, it means that the credentials could not be validated.
As a result, the product can only detect if the device is up or down, and cannot collect any
other data. To resolve this issue, verify the SNMP configuration on the device. If the
credentials still cannot be validated, and you have an active SolarWinds contract, contact
technical support.
137
3. Ensure the interfaces you want monitor are selected, and click Next.
SolarWinds recommends that you do not monitor VoIP interfaces or NULL interfaces.
4. Ensure the volume types you want to monitor are selected, and click Next.
SolarWinds recommends that you do not monitor compact disks or removable disks.
138
5. Review the list of elements to be imported, and click Import.
139
Choose the polling method to use
Select a polling method to monitor nodes in the way that best suits your environment.
The node is not polled, and no data is collected from the node. The node is included in your environment
and used to monitor an application or another element on the node. This method allows you to build a
more complete map of your network environment within your SolarWinds Orion Platform product.
Status Only: ICMP
Limited information is gathered using Internet Control Message Protocol (ICMP) or ping. This polling
method is used to monitor status and measure the average response time and packet loss percentage for
managed devices.
Use this method when you need limited information or to monitor devices that do not support SNMP or
WMI.
This polling method requires that you enable ICMP on your nodes. Consider adjusting any network
intrusion detection systems or your firewalls to allow for the ICMP traffic.
Most Devices: SNMP & ICMP
This method allows you to query the Management Information Base (MIB) and performance indicators that
are tied to specific Object Identifiers (OIDs) in addition to polling the device status, average response time,
and packet loss percentage. This method is suitable for SNMP-enabled devices such as routers, switches,
and computers. You must provide the appropriate SNMP community strings for SNMP v1 or v2c, or SNMP
v3 credentials.
Your devices must have ICMP and SNMP enabled to use this polling method. If you want to poll with a
specific version of SNMP, you must disable all other versions on the device.
Consider adjusting any network intrusion detection systems or your firewalls to allow for the ICMP
traffic.
This polling method can only be used for Windows computers. Windows Management Instrumentation
(WMI) is a proprietary technology used to poll performance and management information from Windows-
based network devices, applications, and components.
When used as an alternative to SNMP, WMI can provide much of the same monitoring and management
data currently available with SNMP-based polling with the addition of Windows specific communications
and security features.
Your devices must have WMI and ICMP enabled to use this polling method. You can use WBEMTest.exe,
which is included on every computer that has WMI installed, to test the connectivity between your
SolarWinds Orion server and your Windows computer.
140
Due to specific characteristics of WMI polling requests, polling a single WMI enabled object uses
approximately five times the resources required to poll the same or similar object with SNMP on the
same polling frequency. Consider adjusting any network intrusion detection systems or your
firewalls to allow for the ICMP traffic.
Windows Servers: Agent
An agent is software that provides a communication channel between the SolarWinds Orion server and a
Windows computer. Agents are used to communicate the information that SolarWinds plug-ins collect to
the SolarWinds Orion server.
Information collected by plug-ins depend on the type of plug-in installed on the agent. For example, the
Quality of Experience plug-in collects packet traffic, while a SAM plug-in collects application data used to
monitor the applications. Agents automatically download the plug-ins for all installed products.
141
Import nodes from a list of IP addresses
Import devices from a seed file in the Network Sonar Discovery wizard.
See the Network Performance Monitor Getting Started Guide for more information about network
discovery.
The Network Sonar Results Wizard opens with the results of your discovery.
142
Manage scheduled discovery results
The Scheduled Discovery Results tab of Network Discovery provides a list of all recently discovered,
changed, or imported devices on your monitored network. Results are compared between discoveries, and
listed on this tab.
1. Log in to the Orion Web Console and navigate to Settings > Network Discovery.
2. Click Scheduled Discovery Results.
3. Filter the results the left pane.
4. Update your SolarWinds Orion database to include changed or discovered nodes by selecting all
nodes to update or to add, and clicking Import Nodes.
5. Ignore devices in future discoveries by selecting the nodes to ignore, and clicking Add to Ignore List.
143
Minimize SNMP processing load during discoveries using the Discovery Ignore
List
Network discoveries often find devices you do not intend to monitor. Add the devices you do not want to
monitor to the Discovery Ignore List to minimize the SNMP load associated with discovering devices not
meant for monitoring.
1. Log in to the Orion Web Console, and navigate to Settings > Network Discovery.
2. Click Scheduled Discovery Results.
3. Select devices you want to ignore, and click Add to Ignore List.
Use items in the Status and Group by lists to help you find devices.
1. Log in to the Orion Web Console, and navigate to Settings > Network Discovery.
2. Click the Discovery Ignore List, and select the objects you want to monitor.
3. Click Remove from Ignore List.
4. Confirm that you want to stop ignoring selected items by clicking OK.
The devices removed from the list will be included in the discovery again.
144
Manage devices in the Orion Web Console
In the Orion Web Console, you can add and remove devices, quickly view and edit device properties from
the Node Management view.
The All Nodes resource is included on the Orion Summary Home view by default, but you can
include it on any other view.
145
Stop monitoring devices
Deleting a node also deletes all its applications, interfaces, and volumes. An individual event may
be recorded for each deleted network object.
To find a monitored application, interface, or volume, expand the parent node, and select the
object.
n To find a node, use the filter and search tools above the node list.
n To group found nodes, select a property in the Group By list.
To delete multiple interfaces on different nodes, use the search tool above the table to find
the nodes, and select the interfaces.
146
View node data in tooltips
Hover over a monitored node in the Orion Web Console to view an immediate status overview of the
device.
Node Status Current status of the node (Up, Down, Warning, Unmanaged, or Unreachable).
Polling IP
The IP address currently assigned to the selected node.
Address
Machine Type The vendor icon and vendor description of the selected node.
Average
The measured average response time of the selected node as of the last node poll.
Response Time
The percent of all transmitted packets that are lost by the selected node as of the
Packet Loss
last node poll.
The percent of available processing capacity on the selected node that is currently
CPU Load
used as of the last node poll.
The percent of available memory on the selected node that is currently used as of
Memory Used
the last node poll.
147
Edit node properties
Only edit node properties in a single browser tab to prevent database errors and data losses.
Available properties depend on the Orion Platform products you have installed.
To find the node, use the filter and search tools above the nodes list.
Edit the node name, web address, and which view opens when you double-click the node
1. To rename the node, type the new name in the Name field.
Changing the node name only affects the way the node is identified on charts and graphs in the
Orion Web Console. It does not impact the node as it is referenced on the network.
2. To change the view which displays details about this node, select the View Type from the list.
3. To change the template for the address used in the Node Details resource that allows you to
navigate to the node from the resource, scroll down to Web Browse Template, and change the
default http://{{HrefIPAddress}}.
4. Click Submit.
1. To change the polling IP address, type the new IP address, or click Select IP Address and select the
new IP address.
Changing the IP address affects data collection. Change the IP address only if it changed on
your network to continue collecting the statistics without reconfiguring the node.
2. To dynamically assign the IP address of the selected node, select Dynamic IP Address (DHCP or
BOOTP), provide the DNS Hostname, and select the IP Address Resolution format.
Some vendor implementations of 64-bit counters produce faulty data. If you notice
erratic or incorrect data, clear the box to disable 64-bit counters.
148
c. Edit the Community Strings (for SNMPv1 and SNMPv2c) or Credentials, Privacy and
Authentication settings (for SNMPv3).
Changing the community string or SNMP port affects data collection. Do not change the
IP address, community string, or SNMP port unless they have changed on your network.
Changing the SNMP port applies to statistics polls, Universal Device Pollers (UnDPs), and
SNMP trap collection. See "Monitoring MIBs with Universal Device Pollers" for
information about UnDPs and "Monitoring SNMP Traps" for information about traps.
1. To add, edit, or delete an existing dependency that includes the node, click Manage Dependencies
and adjust the dependencies.
2. Provide values for custom properties on the node. If you cannot see the required custom property,
click Manage Custom Properties to create or manage custom properties.
3. Click Submit.
1. If the node is a UCS Manager and you want to poll for UCS data, select Poll for UCS, provide the Port
on which the UCS manager listens and credentials.
Click Test to verify that the credentials are valid for the selected UCS Manager.
2. If you have SolarWinds User Device Tracker (UDT) installed and the node has UDT ports attached, you
can poll Layer 3 data. Select Poll Layer 3 Data from Device, and enter the Layer 3 Polling Interval.
3. If SolarWinds SAM is installed, you can monitor Active Directory users that log in to your network.
Select Active Directory Domain Controller, and provide the following information.
a. Select the credential to be used, or select <New Credential>, and define the credential.
Administrator credentials are needed only for installing agents.
149
Customize alerting thresholds
Be informed when polled values for a metric on the node reach unwanted values by specifying custom
thresholds for the node.
1. Scroll down, select Override Orion General Thresholds for the metric, and adjust the default values.
2. Click Submit.
150
Promote a node from ICMP to SNMP monitoring
Orion Platform products only use ICMP to poll devices for status, average response time, and packet loss.
If a node which you added to the SolarWinds Orion database as an ICMP only node also supports SNMP,
and you want to start collecting additional statistics, change the polling method to SNMP.
If you notice erratic or incorrect data when using 64-bit counters, clear the Allow 64 Bit
Counters box for the device, and contact the hardware manufacturer.
10. For SNMPv1 or SNMPv2c, enter the Community String and, optionally, the Read/Write Community
String. Click Test to validate the strings.
The Community String is a password to authenticate data sent between the management
station and the device. The default is usually "public". Use the strings configured on the
device.
11. For SNMPv3, provide the credentials and click Test to validate the credentials. See the vendor
documentation for your network device for further information.
12. Click Submit.
151
View the resources and statistics monitored on a node
Resources monitored on a node include interfaces and volumes. The status of objects is signified by an
icon. The List Resources view also lists statistics monitored on the node.
The interfaces and volumes for this nodes are displayed, showing which are being currently monitored.
152
Suspend collecting data for monitored nodes
Monitored devices are regularly polled for operational status. Collected statistics are displayed in the
Orion Web Console.
You can temporarily suspend data collection on individual nodes, or resume data collection as necessary.
If you suspend collecting data for a node, data collection will also be automatically suspended for all
interfaces and volumes on the selected node.
Suspending data collection is helpful when you need to perform maintenance on a node or its
components, such as upgrading firmware, installing new software, or updating security. Suspend polling
data for the node while the device is down for maintenance to maintain the accuracy of data and prevent
unnecessary alert messages.
Information for the selected node, all monitored interfaces and volumes on it will be collected again.
153
Poll and rediscover devices immediately
Devices are polled for statistics and status regularly, as specified in the Polling Settings. See "Orion Polling
Settings". Discoveries run according to their schedule.
154
Troubleshoot Windows Server memory over 100%
When Orion Platform products poll a Windows server for CPU load and memory utilization, they pull the
amount of physical memory to define the 100% level. Then they total the amount of memory in use by each
allocation to compute what percentage of the physical memory is in use. This can result in memory
utilization readings over 100%, as many applications pre-allocate memory and swap before it is actually
needed.
Workaround
Add physical memory as a volume for monitoring these servers. When monitored as a volume, the
values will be more in line with your expectations.
155
Manage groups and dependencies
Dependencies and groups help you organize how data about your network is presented in the Orion Web
Console.
You can manage Orion objects such as nodes, volumes, applications, interfaces, and even other groups as
groups. By using groups, you can logically organize monitored objects, and use the groups as the basis of
alerts. For example, you can group nodes from the same location and create alerts and reports about the
status of the group.
By defining dependencies between objects, you can better represent the status of objects on your network.
Without dependencies, all monitored objects on an unresponsive monitored node report as down. By
establishing dependencies, the child objects are displayed as Unreachable instead of down. This prevents
false down object alerts.
156
Groups
A group is a collection of monitored objects, such as a group of nodes from the same location, or group of
all nodes owned by a department.
Nesting a group within another does not create a strict parent/child relationship. You can include
any group as a member in any number of other groups.
157
Create groups
Select objects you want the group to contain, or specify group members using a dynamic query based on
shared properties. Objects added through dynamic queries are automatically added or removed from the
group.
To create custom properties, click Manage Custom Properties in a new tab. See Custom
properties.
5. Manually or automatically select objects for this group.
n Select the check box next to the object to select object manually.
n Automatically select group members based on shared properties by clicking Add Dynamic
Query and creating conditions.
Click Preview to verify that the dynamic query is selecting the intended objects.
The new group is listed on the Manage Groups page and can be used in other parts of the product,
including alerts and dependencies.
158
Edit groups
You can edit the properties of an existing group, or add and remove objects.
To create custom properties, click Manage Custom Properties in a new tab. See Creating
Custom Properties.
9. To add or remove the group members, click Add & Remove Objects.
10. To manually select objects for this group:
a. From the Show Only drop-down list, select the type of Orion object to add as a group
member.
b. From the Group by drop-down list, select how you want to group these objects, or select [No
Grouping] to display all.
c. Select the objects, and click Add to Group.
11. To dynamically select group members based on shared properties:
a. Click Add Dynamic Query.
b. Type a name for the query in the Dynamic Query Object Name field.
c. Select an Orion object type.
d. Click Add Condition, and select the property, argument, and value for each condition you
want to use.
e. Click Preview to verify that the dynamic query is selecting the intended objects.
f. Click Save.
12. To edit an existing query:
a. Select a dynamic query, and click Edit Dynamic Query.
b. To edit the query name, edit the Dynamic Query Object Name field.
c. To edit the object type, select the new object type from the Orion Object Is drop-down list.
d. To edit a query condition, edit the property, argument, and value as required.
e. Click Preview to verify that the edited dynamic query is selecting the intended objects.
f. Click Save.
13. To remove an object or query from a group, select the query or object, and click Remove.
159
14. Click Submit to save the edited objects and queries.
15. Click Submit again to save the group.
160
Delete groups
161
Set the group status based on the status of the group members
The Show Best Status selection is useful for displaying groups that are defined as collections of redundant
or backup devices.
The Show Worst Status selection ensures that the worst status in a group of objects is displayed for the
whole group.
The Mixed Status Shows Warning selection ensures that the status of a group displays the worst warning-
type state in the group. If there are no warning-type states, but the group contains a mix of up and down
states, then a Mixed Availability ( ) warning status is displayed for the whole group.
(Critical)
(Critical)
(Mixed Availability)
162
Mirror network object dependencies in the Orion Web Console
Dependencies are parent-child relationships between network objects that allow you to account for
constraints on the network. The constraints can be the result of the design of a specific device, such as
interfaces on a switch or router, or the result of the physical architecture of the network itself.
For example, when a parent object, such as a switch, goes down or becomes unresponsive all interfaces on
the switch will also be unresponsive, even though they may be working.
To account for this situation, the Unreachable status is used for the interfaces, because their parent node
reports as down, and their own status cannot be determined.
Enable Auto Dependencies in the Polling Settings page to create 1:1 parent-child node
dependencies automatically. You can choose to ignore dependencies created this way in the
Manage Dependencies view.
163
Create a dependency between network objects
To define a dependency so that the reported states of child objects depend on the status of
multiple parent objects, create a group including all parent objects, and select it on this view.
164
5. Type a Dependency Name, select the child entities, and click Next.
To define a dependency so that the reported states of multiple child objects depend on the
status of one or more parent objects, create a group including all child objects, and select it
on this view.
6. Review the settings for the dependency. If there are active alerts on child objects, they are listed on
this view.
7. Click Submit.
You can also display the dependency on custom views in the Orion Web Console.
165
Edit a dependency between network objects
1. Click Settings, and click Manage Dependencies in the Node & Group Management grouping.
2. Select a dependency, and click Edit.
3. Select the parent object or group, and click Next.
To define a dependency so that the reported states of child objects depend on the status of
multiple parent objects, create a group including all parent objects, and select it on this view.
For more information, see Create groups.
4. Edit the Dependency name.
5. Select the child object or group, and click Next.
To define a dependency so that the reported states of multiple child objects depend on the
status of one or more parent objects, create a group including all child objects, and select it
on this view.
6. Review the settings for the dependency. If there are active alerts on child objects, they are listed on
this view. If the parent object is down, the listed alerts might be suppressed. See View active alerts
on child objects when the parent object is down.
7. Click Submit.
166
Delete a dependency between network objects
1. Click Settings, and click Manage Dependencies in the Node & Group Management grouping.
2. Select the dependency, and click Delete.
3. Click Yes to confirm.
167
View active alerts on child objects when the parent object is down
When a parent object is down and the dependent child objects are Unreachable, alerts based on polled
statistics are not triggered.
If a child object can be polled using a different route, it is polled as usually, its status does not switch to
Unreachable, and alerts are not suppressed.
You can display active alerts on child objects manually at any time.
1. Click Settings, and click Manage Dependencies in the Node & Group Management grouping.
2. Select the dependency that includes the child object on which the alerts are active, and click Alerts
on Child.
168
Discover applications in your environment
SolarWinds SAM can scan nodes and automatically assign the Application Monitors it deems suitable for
each scanned node. You control the nodes to be scanned, the application templates used in the scan, and
the scanning parameters that determine a match.
In larger environments, adding many applications at once can take a great deal of time. You may
need to log in with an administrator account to perform this action.
Select applications
1. To adjust the template assignment criteria, expand Advanced Scan Settings and move the slider to
the desired setting:
n Minimal Match-At least one component must match to assign the template.
n Partial Match-Some of the components must match to assign the template.
n Strong Match-Most of the components must match to assign the template.
n Exact Match-All of the components must match to assign the template.
2. When you are finished selecting applications, click Next.
Enter credentials
Some application templates require credentials either to access restricted resources, or to run
within the context of a specific user. To scan for these templates, add the necessary
credentials to the list. If a template you are scanning for requires credentials, the credentials
in this list are tried in the order in which they appear.
Warning: Credentials are tried several times over the course of a scan, so an incorrect
password is likely to lock out an account. To avoid potential account lockouts that affect
actual users, SolarWinds recommends that you create and use service accounts. A
service account is an account created specifically for the purpose of providing
credentials to use for SolarWinds monitoring. With service accounts, no actual user is
affected by an account lockout if a password should be entered incorrectly.
If you have domains sharing user names with different passwords, SolarWinds recommends
that you run separate application discoveries for each domain.
169
When you are finished entering credentials, click Next.
Review the summary for the scan. If the automatic discovery matches templates that are
already assigned to the node, by default the template is not assigned a second time. If you
want to assign duplicate templates, select Yes, Assign Anyway from the Do you want to assign
duplicates list.
Click Start Scan to begin the scan. The scan runs in the background. A banner message
appears near the top of the screen, SAM scan in progress.
To view the progress of the scan, click More Details in the banner message. From this screen
you can see the progress of the scan, cancel the scan, or go to the Application Summary
screen.
You are notified by a message near the top of the screen when scanning is complete. Click
More Details to see the results of the scan. Click Application Summary to display the summary
page.
170
Add application monitors to nodes
After adding individual nodes, you are prompted to add applications for monitoring the desired
application(s) on the new node as described below.
Add a node from the web console by clicking Settings > All Settings > Add a Node.
1. Use the Show Only list to select the desired category for the Application Monitors you want to add.
171
Customize the application details view
Applications inherit the custom view setting from their templates in the same way as other template
settings.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Find an assigned Application Monitor without a Custom View.
3. Return to Applications > SAM Summary then click the Application Monitor to view its application
details page.
4. Click Customize Page, then proceed with your customizations.
You can select and create a custom application details view. This custom view is applied at the template
level. Applications inherit the custom view setting from their templates in the same way as other template
settings.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Select an Application Monitor and then click Edit Properties.
3. Click Modify Template Settings in the field Custom Application Details View.
4. Select Yes, use <TemplateName> Details View in the field Custom Application Details View
5. Click Submit, then click the name of the assigned Application Monitor to view its application details
page.
6. Click Customize Page and proceed with your customizations.
After creating a customized application details view for a template, you can change the Custom
Application Details View setting in the template properties to switch between the default view and the
custom view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select a template and then click Edit.
3. If you want applications based on this template to use the default view, set Custom Application
Details View to No, use Default Application Details View.
4. If you want applications based on this template to use the custom view, set Custom Application
Details View to Yes, use <TemplateName> Details View, where TemplateName is the name of the
selected template.
5. Click Submit.
172
Select a view for an application
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Select an Application Monitor and then click Edit Properties.
3. Click Modify Template Settings in the field Custom Application Details View.
4. If you want this application to use the default view, set Custom Application Details View to No, use
Default Application Details View.
5. If you want this application to use the custom view, set Custom Application Details View to Yes, use
<TemplateName> Details View, where <TemplateName> is the name of the selected template.
6. Click Submit.
173
Viewing node and application data in tooltips
Most object within SAM allow you to view information when you hover the mouse over an object. These are
known as tooltips.
Node Tooltips
Hover To see…
over…
Node Current status of the node (up, down, warning, unplugged, or unmanaged)
Status
SolarWinds SAM now supports the ability to include applications in calculation of
node child status. So if node is up, but application on that device is down, you will see
a child status icon indicating there is a problem.
Machine The vendor icon and vendor description of the selected node
Type
Average The measured average response time of the selected node as of the last node poll
Response
Time
Packet The percent of all transmitted packets that are lost by the selected node as of the last node
Loss poll
CPU Load The percent of available processing capacity on the selected node that is currently used as
of the last node poll
Memory The percent of available memory on the selected node that is currently used as of the last
Used node poll
Application Tooltips
174
App Name The name of the application.
App Status The status of the application (up, down, unknown, warning, or critical).
Server Status Operational status of the server (up, down, warning, unplugged, or
unmanaged).
Components with List of the components with problems and their statuses.
Problems
175
Enable SolarWinds SAM data in the Node Details view
You may need to log in with an administrator account to perform this action.
1. On the web console,click Settings > All Settings > Manage Views > Node Details > Edit.
2. Click [+] next to the column in which you want to display SAM resources.
3. Click [+] to expand the Node Detail Reports category, and then check the resources you want to add.
4. Click Submit, then click Done.
5. Navigate to a node with which you have associated an application and review the new resources.
176
Customize SAM Application Summary views
Create a filtered Applications Summary view based on the default SAM Application Summary view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views > SAM Application Summary and
then click Copy.
2. Select Copy of SAM Application Summary and then click Edit.
3. Click Edit in the View Limitation section, then select a view limitation and click Continue.
4. Enter the view limitation criteria and then click Submit.
5. Name this summary view and then click Update and then click Done.
Add a summary view menu item to the menu bar in the Applications tab:
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the summary view you want to add and then click Edit > Preview.
3. On the preview page, make note of the URL field of the browser.
4. Click Settings > All Settings > Customize Menu Bars, then click Edit in the Admin Menu Bar section.
5. Scroll to the bottom of the Available Items list and then click Add.
6. Name the menu item, then enter the URL of the summary view and click OK.
7. Drag the new menu item from the Available Items list to the Selected Items list and then click
Submit.
177
Monitor network events in the web console
SolarWinds SAM automatically logs all events that occur to any monitored devices on your network. These
events are then displayed in the SolarWinds Web Console, so you can view and acknowledge them as your
network management policies require.
The Network Event Log is maintained as part of the Nightly Database Maintenance plan defined
within the Database Settings area of the SolarWinds Polling Setting page in the SolarWinds Web
Console. Records are kept for the number of days specified Events Retention field (the default is 30
days).
1. Click Start > All Programs > SolarWinds > SolarWinds Web Console.
2. Log in to the SolarWinds Web Console, and then click Events in the Views toolbar.
3. Filter the objects or events to which you want to limit your view in the Filter Devices area.
4. Click Refresh to complete your events view configuration.
178
View event details in the web console
SolarWinds logs network events and lists them in the readily customizable Events view of the Web Console.
Events are shown in order of occurrence, and they may be viewed by device, date and time, and event or
device type.
You may need to log in with an administrator account to perform this action.
The Network Event Log is maintained as part of the Nightly Database Maintenance plan defined
within the Database Settings area of the SolarWinds Polling Setting page in the SolarWinds Web
Console. Records are kept for the number of days specified Events Retention field (the default is 30
days).
179
Acknowledge events in the web console
You may need to log in with an administrator account to perform this action.
This procedure clears events in the web console by having you acknowledge them.
180
Manage nodes, applications, and settings from the web
console
You can manage SolarWinds SAM nodes, groups, accounts, alerts, views, and settings. You can also manage
the navigation and look of SolarWinds SAM and view information about available product updates.
You may need to log in with an administrator account to perform these actions.
Unmanage nodes
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Select the nodes to unmanage, and then click Unmanage.
3. Follow the prompts as needed.
1. On the Web Console, click Settings > All Settings > Manage Nodes > Add Node.
2. Provide the host name or IP Address of the node to add in the host name or IP Address field.
3. Select the polling method for monitoring and enter the appropriate credentials as needed, then click
Next.
4. Complete the wizard as instructed. When complete, the added node appears in the All Nodes
resource.
Warning: Deleting nodes from monitoring in the web console automatically stops monitoring of all
applications and volumes on the deleted nodes.
181
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Locate the node to delete using either of the following methods:
n Use the search tool above the node list to search your Orion database for the node to delete.
n Select an appropriate Group by: criterion, and then click the appropriate group including the
node to delete.
3. Check the node to delete in the list, and then click Delete on the toolbar.
1. Locate the object to delete using either of the following methods:
n Use the search above the node list to search your Orion database either for the object to
delete or for its parent object to delete.
n Select a Group by: criteria, and then click the appropriate group including the parent node of
the object to delete.
2. If you have a list of node results, click [+] to expand the parent node of the object to delete.
3. Check the object to delete, and then click Delete on the toolbar, then click OK to confirm deletion.
n If you have defined any custom properties for monitored nodes, you need to provide appropriate
values for the promoted node in the Custom Properties.
n If you plan to use SNMPv3 to monitor the promoted node, you need to provide the following
SNMPv3 credential settings:
n SNMPv3 User name and Context
n SNMPv3 Authentication Method and Password/Key
n SNMPv3 Privacy/Encryption Method and Password/Key
Note: Read/Write SNMPv3 Credentials are optional, but the public Community String is
required
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Check the node to promote, click Edit Properties, and then select Most Devices: SNMP and ICMP.
3. Select the SNMP Version for the promoted node. SolarWinds uses SNMPv2c by default.
4. Enter the appropriate credentials, then click Validate SNMP to confirm your SNMP settings. When
done, click Submit, and then click OK.
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Check the node to promote, click Edit Properties, and then select Windows Servers: WMI and ICMP.
182
3. Enter the appropriate WMI credentials.
4. Click Test to confirm your settings. When done, click Submit, and then click OK.
Setting a node to an unmanaged state automatically suspends the management on the selected node.
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Check the node to change, and then click Unmanage or Remanage, as appropriate for the selected
node.
3. If you selected Unmanage, you must provide start and end times and dates for your management
suspension, and then click OK.
1. On the Web Console, click Settings > All Settings > Manage Nodes.
2. Check the node to poll or rediscover, and then select the appropriate action from More Actions drop
down menu.
n The Unmanage Scheduling Utility can be found at Start > SolarWinds Orion > Advanced Features >
Unmanage Scheduling Utility.
1. Select either New Task or open an existing task by clicking Edit Task, then click Add Items.
2. Click on the Web tab and select the items to schedule to be stopped by checking the check box next
to the item name.
3. Click Add, then select the length of time you would like the selected item to be stopped.
4. Click OK. Optionally, click Save Task to save your selections for future use.
1. Check the item and its details appear in the Task Item Properties pane.
2. You can change the settings of the item's schedule by selecting an item and clicking Set Duration.
3. You can delete an item from the unmanage schedule by selecting it and clicking Delete Checked
Items.
It is possible to create a conflict of schedules if you choose the same item to be stopped using both
the web console and the Unmanage Scheduling Utility with different durations.
183
Access nodes using HTTP, SSH, and Telnet
The SolarWinds Web Console supports the use of HTTP, SSH, and Telnet protocols for remote device access
if associated applications like PuTTy and FiSSH on your SolarWinds server are properly registered. Launch
remote access applications from any Details view as follows:
184
Manage SAM settings and general thresholds
Settings are broken into specific sections, making them easier to control.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Accounts.
2. Select an account to edit by checking its box, then click Edit.
3. Select the desired options, and then click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SolarWinds Thresholds.
2. Provide values for Error Level, High Level, or Warning Level for the selected thresholds.
185
Certificate Credentials Library
The Certificate Credentials Library allows you to import and store certificates for use at a later time.
Typically, you need to associate credentials with component monitors and templates to enable them to
retrieve application data. For added security, SAM offers the ability to store certificates in the Certificate
Credentials Library.
Certificates can be used for authentication with Linux devices monitored in SAM. Linux, Unix, and Nagios
script monitors also support certificate based authentication.
186
Understand the Credentials Library
You typically need to associate credentials with component monitors to enable them to retrieve application
data. For example, to use a WMI monitor, you must provide valid domain or computer credentials. Or, if
your web server requires credentials, you must provide the appropriate credentials to access the
protected sections of your site.
n Adding credentials to the Credentials Library for use later. See the section Adding Credentials to the
Credentials Library.
n Creating credentials on the spot (Quick Credentials) when editing templates and component
monitors. See the section Using Quick Credentials.
n Editing credentials. See the section Editing Credentials in the Credentials Library.
n Deleting credentials. See the section Deleting Credentials from the Credentials Library.
n db_owner
n db_accessadmin
n db_securityadmin
n db_ddladmin
n db_datareader
n db_datawriter
n db_backupoperator
Notes:
n SolarWinds Server & Application Monitor uses the same SNMP credentials that you entered during
node discovery. There is no need to specify additional credentials for SNMP operations.
187
n SolarWinds SAM stores credentials encrypted in the database.
n The ability to Inherit Windows credentials from node is available in the drop down list.
188
Add, edit, and delete credentials within the Credentials Library
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Credentials Library > Add New
Credential.
2. Provide a name for the credential set. SolarWinds Server & Application Monitor displays this name in
the Credential for Monitoring field of monitors that accept credentials.
3. Provide the user name and password, and then confirm the password and click Submit. If you are
providing windows credentials for accessing and harvesting information through WMI, ensure you
provide the account name in the following syntax: domainOrComputerName\user name for domain
level authentication or User Name for workgroup level authentication.
You can assign credentials to all the associated components of a template or application monitor.
You may need to log in with an administrator account to perform this action.
1. From the Credentials Library, click Edit for the desired credential.
2. Modify the information as needed and then click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Credentials Library.
2. Click Delete for the desired credential.
3. Click OK to confirm the deletion.
189
Add a certificate to the library
Adding a certificate to the Certificate Library stores the certificate for later use.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Certificate Credentials Library.
2. Click Add New Credential, then enter a name in the Credential Name field.
3. Enter a User Name then click Browse… to load a private key from a file.
4. Enter a password in the Private key content password field.
5. Select the Private key type: either RSA or DSA then click Submit to save the certificate credential to
the library.
190
Assign certificate credentials
There are two ways to assign Certificate Credentials; when assigning a template to a node, and when
editing a template directly.
n If every node uses unique private keys, then editing the application after it has been assigned is the
best option. Use, When assigning a template to a node.
n If most or all of your nodes use the same private key, then you should edit the credentials directly in
the template. Use, Edit a template directly.
n Credential Name: User-defined text that is used to identify the credential for later use in templates.
n User Name: The user who is associated with the public key certificate on the target computer.
n Key: Text content of the private certificate file in Privacy Enhanced Mail (PEM) format.
n Key type: The algorithm the certificate used to generate the certificate pair. (This can be found as
part of the header. For example, e.g. "--- BEGIN RSA PRIVATE KEY---.")
n Key password: The password used to protect the certificate file
The Credentials Library differs from the Certificate Credentials Library. The Credentials Library
stores credentials for later use. The Certificate Credentials Library is used by SAM to configure
components, which uses certificate authentication. (For example, A Linux Script Monitor
authenticated using SSH.)
4. From here, you can select one or more Linux/Unix/Nagios script component monitors to edit by
checking the boxes to the left of each monitor and then clicking Multi-Edit.
5. Check the Authentication Type box and select User name and PrivateKey from the drop down menu.
6. Check the Credential for Monitoring box and select the credentials you want to use from the drop
down menu, and then click Save.
191
Edit a template directly
192
Use Quick Credentials
Create and assign credentials using Quick Credentials when editing a template or application monitor.
1. If the credential you want to assign does not exist, create it by following these instructions:
a. Select <New Credential> in the Choose Credential field.
b. Type a name for the new credential in the Credential Name field.
c. Type the user name for the credential in the User Name field.
d. Type the password in the Password field, and type it again in the Confirm Password field.
2. To assign an existing credential, select the credential from the Choose Credential field.
3. Click Set Component Credentials to set this credential as the credential for all the components in the
Application Monitor or template.
The ability to Inherit Windows credentials from node is available in the drop down list.
Anywhere you have the option to specify credentials for an application template or
component monitor, you also have the the option to utilize the existing WMI credentials
already used to manage the host.
193
Configure and manage the web console
n Administrative Functions of the Orion Web Console
n Customize views
n Use Orion Web Console breadcrumbs
n Installing Network Atlas on a Remote Computer
194
Administrative Functions of the Orion Web Console
The following sections describe the primary administrative functions performed by an Orion Web Console
administrator.
195
Manage accounts and limitations
SolarWinds Web Console user accounts, permissions, and views are established and maintained with the
SolarWinds Account Manager. When Advanced Customization is enabled on the SolarWinds Website
Settings page, you can use Account Manager to customize menu bars and views for different users.
n This guide assumes that Advanced Customization has been enabled. If it has not been enabled, the
range of options available on the pages referenced in the following sections is much more limited.
n To prevent issues with web console accounts, your SQL Server should not be configured with the No
Count connection option enabled. The No Count option is set in the Default Connection Options
area of the Server Properties > Connections window of SQL Server Management Studio.
Create accounts
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Accounts > Add New Account.
2. Select the type of account to add, and then click Next.
a. For a SolarWinds individual account, provide a User Name and a Password then define user
settings and privileges.
b. For a Windows individual account, provide the User Name and Password for a user that has
administrative access to your Active Directory or local domain, then in the Search for Account
area, enter the User name of the Active Directory or local domain user for whom you want to
create a new web console account, and then click Search. In the Add Users area, select the
users for whom you want to create new web console accounts, and then click Next.
c. For a Windows group account, provide the User Name and Password for a user that has
administrative access to your Active Directory or local domain, then in the Search for Account
area, enter the Group name of the Active Directory or local domain group for which you want
to create a new web console account, and then click Search. In the Add Users area, select the
users for whom you want to create new web console accounts, and then click Next.
When the new account is created, the Edit User Account view displays, showing all configurable account
options.
You may need to log in with an administrator account to perform this action.
The Edit User Account page provides options for configuring web console user accounts. On the Edit User
Account page, administrators can disable an account, set an account expiration date, grant administrator
and node management rights, set user view limitations, define a default menu bar, and set several other
defaults defining how a user account views and uses the SolarWinds Web Console.
196
1. On the Web Console, click Settings > All Settings > Manage Accounts.
2. Select an account, then click Edit.
3. Make your changes as needed, then click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Accounts.
2. Select and account then click Edit > Add Limitation.
3. Make your changes as needed, then click Continue > Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Accounts.
2. Select and account, the click Edit.
3. From the Account Limitation sections, click Delete to the right of the limitation you want to delete.
197
Set the default account menu bars and views
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Accounts.
2. Select and account then click Edit.
3. Scroll down to Default Menu Bar and Views and make your selections. When done, click Submit.
198
Enable Windows Authentication with Active Directory
The Orion Web Console can authenticate Active Directory users and users who are members of Active
Directory security groups by using MSAPI or LDAP. By default, Windows individual or group accounts use
MSAPI to authenticate accounts.
You can only use one authentication protocol at a time. All Windows accounts are authenticated through
MSAPI or LDAP, depending on which one is enabled.
SolarWinds offers a free analyzer tool for Active Directory that provides instantaneous visibility into
effective permissions and access rights. The tool provides a complete hierarchical view of the
effective permissions access rights for a specific file folder (NTSF) or share drive. Download it for
free from here: http://www.solarwinds.com/products/freetools/permissions_analyzer_for_active_
directory/.
1. Enable the Orion Web Console to use automatic Windows Authentication.
a. Start the Configuration Wizard in the SolarWinds Orion > Configuration and Auto-Discovery
program folder.
b. Select Website, and click Next.
c. Provide the appropriate IP Address, Port, and Website Root Directory, and select Yes - Enable
Automatic Login Using Windows Authentication.
d. Click Next, and complete the Configuration Wizard.
2. Log in to the Orion Web Console using the appropriate domain and user, providing Domain\User
name or Username@Domain as the User Name.
3. Run the Configuration Wizard and enable Windows authentication.
4. Login to the Orion Web Console, and navigate to Settings > All Settings. In Web Console Settings,
select Enable automatic login in the Windows Account Login drop-down.
199
Notifications in the Orion Web Console
Click the bell icon in the top-right corner to display unread notifications.
n If you configured the Orion Web Console to check for product updates, an announcement displays
when an update, such as any upgrade, service pack, or hotfix becomes available.
n If you configured the Orion Web Console to store blog posts, new and unread posts to the Orion
Product Team Blog are announced in the notification bar.
n If you configured a scheduled discovery, results display in the notification bar when the discovery
completes.
n If you are monitoring any VMware ESX or ESXi Servers, the notification bar displays the number of
ESX nodes found during any discovery, and inform you if any discovered ESX nodes require
credentials.
n If you are monitoring Hyper-V nodes, the notification bar informs you when Hyper-V servers were
found during a discovery.
200
Log in for the first time as an Administrator
1. Launch the Orion Web Console using either of the following methods:
n Start Orion Web Console in your SolarWinds Orion program folder.
n Launch a browser and enter http://ip_address or http://hostname, where ip_address
is the IP address of your SolarWinds Orion server, or where hostname is the domain name of
your SolarWinds Orion server.
2. Enter Admin as your User Name, and click Login.
Until you set a password, you can log in as Admin with no password. After your first login,
change the Admin password. See Change account passwords.
201
View and configure the SolarWinds web console message center
The Message Center provides a single, customizable view in the web console where, in a single table, you
can review all events, alerts, traps and Syslog messages on your network.
You may need to log in with an administrator account to perform this action.
Suppress events
There is no option within SAM to suppress event types from the web console; however, suppression can be
accomplished by modifying the database directly using Microsoft SQL Server Management Studio. You can
suppress specific events based on the event type. In order to do this, refer to the Microsoft SQL Server
Management Studio documentation.
202
Change account passwords
When you Server & Application Monitor Getting Network Performance Monitor Getting
log in to the Started Guide Started Guide
Orion Web User accounts User accounts
Console for How user accounts work How user accounts work
the first time, Create a user Create a user
SolarWinds Enable Active Directory Windows Use Active Directory credentials
recommends authentication for users
that you Change account passwords Change account passwords
change the
password for
the Admin account.
1. Log in to the Orion Web Console, and click Settings > All Settings.
2. Click Manage Accounts in the User Accounts grouping.
3. Select a user, and click Change Password.
4. Enter and confirm the new password, and click Change Password.
203
View secure data
Sensitive network information, such as community strings, logins, and passwords, is not viewable in the
Orion Web Console.
If you have secured your network, you can display secure data in the Orion Web Console.
This setting does not affect the display of custom reports that you export to the web. See Creating
Reports in the Web Console.
204
Manage counter rollovers
The Counter Rollover setting configures SolarWinds SAM to properly handle counter rollovers. SolarWinds
SAM is capable of handling either 32-bit or 64-bit counters, but, by default, SolarWinds SAM assumes
counters are 32-bit. 32-bit counters have a maximum value of 232, or 4,294,967,296, and 64-bit counters, if
they are supported by your network devices, have a maximum value of 264, or 18,446,744,073,709,551,616.
Note: The 32-bit counters option is designated as Method 1 in the Counter Rollover field on the SolarWinds
Polling Settings page.
You may need to log in with an administrator account to perform this action.
1. On the web console, navigate to Settings > All Settings > Polling Settings.
2. If you are using 64bit counters, select Method 2 in the Counter Rollover field in the Calculations &
Thresholds area.
Notes:
n If Method 2 is selected, SolarWinds SAM intentionally skips a poll if a polled value is less than
the previous polled value to permit counting to 264.
n SolarWinds fully supports the use of 64-bit counters; however, these 64-bit counters can
exhibit erratic behavior in some implementations. If you notice peculiar results when using
these counters, disable the use of 64-bit counters for the problem device and contact the
device manufacturer.
3. If you are using of 32bit counters, select Method 1 in the Counter Rollover field in the Calculations &
Thresholds area.
Note: If Method 1 is selected, when a rollover is detected, the time between polls is calculated as (232
– Last Polled Value) + Current Polled Value.
205
Enabling and using Integrated Remote Desktop
1. Enable Toolset integration on your user account. On the Web Console, click Settings > All Settings
> Accounts, select an account, then click Edit.
2. Set Allow Browser Integration to Yes.
3. Open the Node Details view for the server you want to view remotely.
4. Click the last button located at the top right of the Node Details view.
Note: Depending on the security settings of your browser, you may be asked to install an ActiveX
control for remote desktop viewing. Follow all prompts to install this required control.
5. Verify the Server IP address or host name, select an appropriate Screen Size, and then click Connect.
206
Use Orion Web Console breadcrumbs
As you navigate Orion Web Console views, you can use breadcrumbs to the pick other views that are on the
same or higher navigational level as your current view.
You cannot view breadcrumbs in wizards, dashboards, or full-page resources such as All Active Alerts.
Only the first 50 monitored nodes, listed in alphanumeric order by IP address, are displayed.
Customize breadcrumbs
1. Click > at an appropriate level in the breadcrumbs to open the drop-down.
2. Click Customize This List.
3. Select an option from the menu, and click Submit.
All items in the customized list will be identical for the selected criterion.
207
Customize views
Orion Web Console views are configurable presentations of network information that can include maps,
charts, summary lists, reports, events, and links to other resources.
Customized views can be assigned to menu bars. With NOC View Mode enabled, views may be optimized
for display in Network Operations Centers.
To make views and graphs larger for larger screens, resize the columns dynamically (drag the
division bars) and use your browser zoom controls, such as <Ctrl>+<+> in Chrome.
208
Create and edit custom views and view limitations
You can customize the SolarWinds Web Console and views for individual users by logging in as an
administrator and creating new views.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views and then click Add.
2. Enter the Name of New View, then select the Type of View.
Note: The Type of View selected affects how the view is made accessible to users, and your choice
may not be changed later.
3. Click Submit.
After you have created a new view, the Customize Your View page opens.
Edit views
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the view you want to customize from the list, and then click Edit.
Note: Click Edit under View Limitation to access.
3. Make your changes as needed. When done, click Done.
As a security feature, the web console gives administrators the ability to apply device-based view
limitations. The following views and limitations are available:
209
Custom Summary Machine Type Pattern Single Group
Virtualization summary
Volume Details
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the view to which you want to add a limitation, and the click Edit.
3. In the View Limitation area of the Customize View page, click Edit.
4. Select the type of view limitation you want to apply, and then click Continue.
5. Provide or check appropriate strings or options to define the device types to include or exclude from
the selected view, and then click Submit.
Note: The asterisk (*) is a valid wildcard. Pattern limitations restrict views to devices for which the
corresponding fields include the provided string.
Copy views
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the view you want to copy, and then click Copy.
Delete views
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the view you want to delete, and then click Delete.
210
Assign views by device type
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Views by Device Type.
2. Select available Web Views for the different types of devices that Orion is currently monitoring or
managing on your network.
3. Click Submit.
n The Export to PDF feature requires IIS Anonymous Access. Confirm that the IUSR_SERVERNAME user
is in the local Users group on your Orion server.
1. Open the web console view to export, and then click Export to PDF in the top right corner of the
view.
2. Navigate to an appropriate location, provide an appropriate file name, and then click Save.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Available Product Updates.
2. The Check for Product Updates option can be enabled or disabled. Make you selection, then click
Save Settings.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click My Dashboard > Home > Custom Summary.
2. Click Edit in any Custom Object Resource, then provide a Title and Subtitle for the selected Custom
Object Resource.
3. Click Select SolarWinds Object. On the Select a network object window, use the Show only and
Group by selection fields, as appropriate, to filter the list of monitored objects.
4. Select the SolarWinds object on which you want to base the selected Custom Object resource, and
then click Select SolarWinds object.
5. Select the type of information you want the custom resource to display about the selected object,
and then customize the resource, as needed.
6. When done, click Submit.
Note: For more information about customizing available resource types, click Help in the header of
any resource on the Custom Summary view, and then click the corresponding resource type.
211
Sam allows you to add vertical tabs on any page in the web console, allowing you to customize the data you
view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Check Enable Left Navigation. The following screen appears:
At this point, you can customize each sub-view tab with its own resources just as you would for any other
view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Color Scheme.
2. Select the desired color scheme, and then click Submit.
212
1. Place your graphic in the images directory.
Note: By default, it is in C:\Inetpub\SolarWinds\NetPerfMon\.
2. On the Web Console, click Settings > All Settings > Web Console Settings.
3. Type the new logo image name as a replacement for SolarWinds.Logo.jpg in the Site Logo URL field.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Color Scheme.
2. Select the desired color scheme, and then click Submit.
213
Manage and edit NOC views
SAM offers a Network Operations Center (NOC) view that hides console tools while automatically rotating
through custom views. NOC view mode enables you to customize views for optimal display on large
network operations center screens. Once you click on an object in NOC view mode, you are taken out of
NOC view mode and then taken to that object's details page.
While in the NOC view you can easily exit and edit the NOC view from the web console by the menu
provided in the upper right-hand corner of the web console, as shown:
You may need to log in with an administrator account to perform these actions.
1. On the Web Console, click Settings > All Settings > Created NOC Views.
2. Select an existing view, then check Enable NOC.
Add NOC views
1. On the Web Console, click Settings > All Settings > Created NOC Views > Add New View.
2. Name then add the desired view. When done, click Submit.
3. If not already done so, check Enable NOC View Mode, then click Done & Go to NOC.
Viewing the AppStack Environment in a NOC view can only be achieved by first adding a new NOC view,
and then creating and applying an AppStack filter for this new view. Once complete, the AppStack resource
becomes part of the NOC view with the filter already applied.
1. On the Web Console, click Settings > All Settings > Created NOC Views.
2. Select a NOC view, click Edit, then check Enable Left Navigation.
214
3. Click Add Tab, add a name for the tab in the field provided, and then click Update. The new tab
appears in the column to the left.
4. Add the AppStack Environment resource to a column by clicking the green [+], then selecting
AppStack Environment from the pop-up dialog.
215
6. If not already done so, check Enable NOC View Mode, and then click Done.
Edit NOC views
1. On the Web Console, click Settings > All Settings > Created NOC Views.
2. Check the desired view to edit, and then click Edit.
3. Make your changes, and then click Done & Go to NOC.
Disable NOC views
1. On the Web Console, click Settings > All Settings > Created NOC Views, as shown:
2. Check the desired view to edit, and then click Disable NOC.
3. Confirm the dialog to have your view removed from the list.
216
Applying node filters
1. From the web console. click Edit in any node list resource.
2. Provide an appropriate SQL query in the Filter Nodes (SQL) field, and then click Submit.
Note: By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so order by clauses included in SQL filters are
redundant and will result in Custom SQL filter formatting errors.
Filter the results to only show nodes that are not Up:
Status<>1
3 = Warning (The node may be responding, but the connection from the server to the Node is dropping
packets)
City = 'Atlanta'
217
Customize SAM views and tabbed sub-views
SAM allows you to add vertical tabs on any page in the web console, allowing you to customize the data
you view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Check Enable Left Navigation. The following screen appears:
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select SAM Application Summary and then click Copy.
3. Select Copy of SAM Application Summary and then click Edit.
4. Click Edit in the View Limitation section, then select a view limitation and click Continue. For example,
Application Name Pattern.
5. Enter the view limitation criteria and then click Submit. For example: *Oracle*
6. Enter a new name for this summary view and then click Update. For example: SAM Oracle
218
Application Summary
7. Click Done.
Add a Summary view menu item to the menu Bar in the Applications tab
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Views.
2. Select the summary view you want to add and then click Edit. For example: SAM Oracle Application
Summary.
3. Click Preview, then on the preview page, make note of the URL field of the browser. For example,
http://SolarWinds/SolarWinds/SummaryView.aspx?viewid=27
4. Click Settings > Customize Menu Bars, then click Edit in the Admin Menu Bar section.
5. Scroll to the bottom of the Available Items list and then click Add.
6. Enter a name for the menu item. For example: Oracle
7. Enter the URL of the summary view, then click OK.
8. Drag the new menu item from the Available Items list to the Selected Items list and then click
Submit.
Applications initially share a generic, default application details view. You can add, remove, or rearrange
resources in this default view, or you can create completely new views that you can apply to groups of
applications according to their templates.
Availability Statistics
You may need to log in with an administrator account to perform this action.
219
2. Click the application monitor to view its application details page, then click Customize Page.
3. Proceed with your customizations.
You can select and create a custom application details view. This custom view is applied at the template
level. Applications inherit the custom view setting from their templates in the same way as other template
settings.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Check the check box next to an Application Monitor and then click Edit Properties.
3. Click Modify Template Settings in the field Custom Application Details View.
4. Select Yes, use <TemplateName> Details View in the field Custom Application Details View, where
TemplateName is the name of the selected Application Monitor template, then click Submit.
5. Click the name of the assigned Application Monitor to view its application details page, then click
Customize Page.
6. Proceed with your customizations.
After creating a customized application details view for a template, you can change the Custom
Application Details View setting in the template properties to switch between the default view and the
custom view.
For each template or application based upon a template, you can select either the default application
details view or the template's custom details view.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the check box next to a template and then click Edit.
3. Set Custom Application Details View to either Yes or No, Use Default Application Details View.
4. Click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Check the box next to an Application Monitor and then click Edit Properties.
3. Click Modify Template Settings in the field Custom Application Details View.
220
4. Set Custom Application Details View to Yes or No, use Default Application Details View.
5. Click Submit.
221
Customize object resources in the SolarWinds web console
The SolarWinds Web Console provides a Custom Object resource that enables you to configure any of a
wide array of resources to display performance data for any specific monitored objects.
Notes:
222
Add external website views
You can select any external website and add it to the Orion Web Console as a view.
1. Log in to the Orion Web Console and click Settings > All Settings in the menu bar.
2. In the Customize Navigation & Look grouping, click External Websites.
3. Click Add.
4. Provide a Menu Title. This will be used for the website in the My Dashboards menu bar.
5. If you want to include a heading for the view, provide an optional Page Title.
6. Provide the URL of the external website, in http://domain_name format.
7. Select the Menu Bar to which you want to add the website link.
See My Dashboards.
If you select Admin as the menu bar, the website will be available from My Dashboards >
Home for administrators.
223
My Dashboards
My Dashboards provide menu bars with shortcuts to Orion Web Console views. The default menu bars
include Home, and a menu bar for each installed Orion Platform product.
You can customize views and labels offered in default menus for individual users.
If you do not need to see all items in menu bars, and prefer navigating to display items in a menu
bar, click My Dashboards > Collapse.
224
Customize My Dashboards
Menu bars available in My Dashboards depend on the settings in your user account.
1. Find out which menu bar is assigned to Home, Network, or other product-specific tab for your user.
See Specify My Dashboard menu bars for users.
2. Add an Orion Web Console view or an external web page to the menu bar. The change will concern
all users who access the menu bar from My Dashboards. See Add items to My Dashboards.
To add a link to a details view for an important device, go to the view, copy the URL, and add it
as an extra item to the view.
3. To provide access to a specific set of links for specific users, create a menu bar, add the links and
assign the menu bar as the Home tab for the user(s).
The items users see in My Dashboards and in Alerts & Activity are specified in their user accounts.
Improve performance by setting the Home Page View to a view with a limited number of resources
on it.
5. Select Yes for the items the user will see in the Alerts & Activity menu bar.
225
6. Select an item and use the arrows to change the order of menu bars. Select an item from the list to
specify the default Home page view.
The user can now use the specified links in My Dashboards and Alerts & Activity menu bars.
3. Drag available items from the left-hand column to Selected Items on the right.
You can also add links to node details views for specific nodes, or to external Internet pages
as a menu item.
226
a. Click Add below the Available items list, provide a name, URL and description for the
menu item, and click add.
b. Drag the new item to the Selected items column.
When you have a list of items you want users to access from My Dashboards, create a menu bar.
The new menu bar is created. You can now assign it to users who will see the items in My Dashboards.
227
Configure the web console and backup
SolarWinds SAM has the ability to create, restore, and clear your web console configuration
1. Locate and run the OrionWebBackup.exe utility, typically located at C:\Program Files (x86)
\SolarWinds\Orion.
2. Click Create Backup.
3. Name your backup and click Save.
1. Locate and run the OrionWebBackup.exe utility, typically located at C:\Program Files (x86)
\SolarWinds\Orion.
2. Select a Backup file from the list.
3. Choose either Merge or Overwrite for the restoration process.
4. Click Restore Backup.
1. Locate and run the OrionWebBackup.exe utility, typically located at C:\Program Files (x86)
\SolarWinds\Orion.
2. Click File > Clear Web Configuration.
3. Click Yes to confirm the deletion of your current web console configuration.
228
Resource configuration examples
Several resources that may be selected from the Add Resources page require additional configuration.
Network maps created with Network Atlas can give a quick overview of your network. Add a Network Atlas
map on a view.
1. Open a view where you want to add the map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Map, and click Add Selected Resources.
5. Click Preview to preview the map, and click Edit to customize the resource.
6. Select a map.
7. Specify the Zoom percentage at which you want to display the map.
If you leave the Zoom field blank, the map displays at full scale, based on the size of the
column in which the map displays.
1. Open the view where you want to add the list of objects on a map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select List of Objects on Network Map, and click Add Selected Resources.
5. Click Preview to preview the map, and click Edit to customize the resource.
6. Select a network map from the list of maps, and click Submit.
The view will now include a resource listing objects on the selected map.
1. Open the view where you want to add the list of maps, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Custom List of All Maps, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Select maps you want to include in your maps list.
7. Click Submit.
229
Display the Worldwide Map
The worldwide map provides a quick geographical overview of your network at any level from global down
to street.
The worldwide map provides a quick geographical overview of your network at any level from global down
to street.
1. Open the view where you want to add the Worldwide Map, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter map in the Search box, and click Search.
4. Select Worldwide Map, and click Add Selected Resources.
5. Click Preview, and if the map looks correct, click Done.
You have now added the Worldwide map to the view. Customize the world map now.
1. Open the view where you want to add the events summary, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
3. Enter event in the Search box, and click Search.
4. Select Event Summary, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Select the time period for displaying events in Time Period.
7. Click Submit.
You can copy URLs of external websites or customized views from preview pages, and copy them to the
User Links resource.
1. Open the view where you want to add the links resource, and click Customize Page.
2. Click the plus sign in the column to open the Add Resource dialog.
230
3. Enter links in the Search box, and click Search.
4. Select User Links, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit to customize the resource.
6. Enter the following information for each link you want to define:
a. A link Name and the URL of your link.
b. If you want your links to open in a new browser window, select Open in New Window.
Https URLs are not supported.
When you have static information that you want to provide in the Orion Web Console, add the Custom
HTML resource on a view. This resource can also provide quick access to customized views.
1. Open the view where you want to add the custom resource, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter html in the Search box, and click Search.
4. Select Custom HTML, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
6. Enter HTML formatted content as required.
7. Click Submit.
Filter nodes
The Orion Web Console can maintain a customizable node list for your network. Node lists can be
configured for specific views using SQL query filters.
1. Open the view where you want to add the node list, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter nodes in the Search box, and click Search.
4. Select All Nodes - Table, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
6. To filter your node list by text or IP address range, provide the text or IP address range by which you
want to filter your node list in the Filter Text field:
n Type Home in the Filter Text field to list all nodes with "Home" in the node name or as a
location.
n Type 192.168.1.* in the Filter Text field to list all nodes in the 192.168.1.0-255 IP address
range.
7. Select the property for the filter text provided above:
n If you typed Home in the Filter Text area, select Node Name or Location to list nodes with
"Home" in the node name or as a location.
n If you typed 192.168.1.* in the Filter Text area, select IP Address to list only nodes in the
192.168.1.0-255 IP address range.
231
8. To apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes (SQL) field.
By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so ORDER BY clauses included in SQL
filters are redundant and will result in Custom SQL filter formatting errors.
The Orion Web Console can maintain a customizable node list for your network. Node lists can be
configured for specific views with node grouping.
1. Open the view where you want to add the node list, and click Customize Page.
2. Click the plus sign in a column to open the Add Resource dialog.
3. Enter nodes in the Search box, and click Search.
4. Select All Nodes - Tree, and click Add Selected Resources.
5. Click Preview to preview the resource, and click Edit in the resource.
6. Select up to three criteria, in specified levels, for Grouping Nodes within your web console view.
7. Select whether you want to put nodes with null values In the [Unknown] Group or ungrouped At the
Bottom of the List.
8. To apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes (SQL) field.
By default, node list resources are designed to sort nodes alphabetically by node caption. This
configuration cannot be overwritten using a SQL filter, so ORDER BY clauses included in SQL
filters are redundant and will result in Custom SQL filter formatting errors.
The Orion Web Console can display a service level agreement (SLA) line on any Min/Max/Average bps
chart. When you add a customer property named "SLA" and populate the field with your device SLA values,
the Orion Web Console displays the appropriate line on your charts.
232
7. Select and add all interfaces to which you want to apply the same service level, and then click Select
Interfaces.
8. Enter the SLA value (in bps) in the SLA column for each interface you want to label with SLA values.
For example, type 1544000 for a T1 interface (1.544 Mbps) or 225000 for a serial connection
running at 225 Kbps.
9. To enter a different SLA value for a different set of interfaces, click Add More.
10. Click Submit.
Browse to the Interface Details view of one of the interfaces you edited. The SLA line displays on any chart
showing Min/Max/Average bps.
233
Integrating and enabling SolarWinds Engineer’s Toolset
n The first time the Toolset tools are accessed, a security warning may be displayed. Click Yes to allow
the Toolset integration.
n To add an external script to the Toolset Integration menu, save the script in an appropriate location
on the install volume of your SolarWinds server (e.g. <InstallVolume>:\\Scripts\).
n To add an external application to the Toolset Integration menu, install the application in an
appropriate location on the install volume of your SolarWinds server (e.g.
<InstallVolume>:\\Application\).
Note: The string supplied for Title is the name for the added script or application that will
display in the menu. The string supplied for the ExecString is the path to the script or
application executable file.
4. Save the new SWToolset.MenuOptions to automatically update the Toolset Integration menu.
234
235
Schedule tasks to be stopped using the Unmanage Scheduling utility
The Unmanage Scheduling Utility can be found by clicking Start > SolarWinds Orion > Advanced Features >
Unmanage Scheduling Utility.
1. Select either New Task or open an existing task by clicking Edit Task, then click Add Items.
2. Click on the Web tab and select the items you want to schedule to be stopped by checking the check
box next to the item name.
3. Click Add, then select the length of time you would like the selected item to be stopped.
4. Click OK. Optionally, click Save Task to save your selections.
1. Check the item and its details will appear in the Task Item Properties pane.
2. You can change the settings of the item's schedule by selecting an item and clicking Set Duration.
3. You can delete an item from the unmanage schedule by selecting it and clicking Delete Checked
Items.
It is possible to create a conflict of schedules if you choose the same item to be stopped using both
the web console and the Unmanage Scheduling Utility with different durations.
236
Monitor your network
View events, alerts, traps, and syslogs in the Orion Web Console Message
Center
The Message Center provides a view where you can see all events, alerts, traps, and Syslog messages on
your network.
Monitor the health of the following Server Blade Chassis without the need for additional software:
n HP C7000
n HP C3000
n Dell M1000e
Hardware monitoring is achieved by polling via SNMP or WMI, depending upon the node. For SNMP and
WMI nodes, hardware monitoring must be enabled manually through the Orion Web Console.
If you run a scheduled Network Sonar Discovery of your existing servers, any servers that support
hardware health information are collected the next time the discovery runs.
Monitoring your hardware's health does not count against your allotted licenses.
There are two ways for administrators to add server hardware monitoring for nodes; through the Add
Node wizard, and through the Node Details group of the Node Details page.
237
Add Node Wizard
From the Add Node wizard, the option to display Hardware Health of Servers is available after a node has
been defined. Check this box to enable hardware health monitoring.
You may need to log in with an administrator account to perform this action.
To disable hardware monitoring, navigate back to this screen and uncheck Hardware Health of
Servers, then click Submit.
Hardware monitoring is automatically enabled for VMware ESX and ESXi servers. Monitoring of VMware
servers uses the CIM protocol which should be enabled by default after the installation of ESX/ESXi hosts.
If installing Hardware Monitoring Agent software on a VMware host, hardware information will be detected
by SAM and the check box to monitor Hardware Health of Servers will be displayed, even where hardware
information might already be collected via the vCenter using the VMWare API. When this option is
displayed for a VMware host, checking it will not change the hardware polling method when Poll for
VMware is also selected.
If you are polling your hosts though the vCenter, you will not see the hardware option listed when you click
List Resources as these nodes tend to be ICMP. This information is automatically collected by Orion, when
available, through the VMware API. You will need to ensure you have the vCenter Hardware Status plug-in
enabled on your V-Center for this information to be available though the VMware API, as shown below:
238
Port 5989 must be opened when polling VMware servers using the CIM protocol.
If you run a scheduled Network Sonar Discovery of your existing servers, Orion will automatically collect
any servers that support hardware health information the next time the scheduled discovery runs.
Each vendor’s hardware monitoring agent software includes a web server that operates on a unique port.
Server Blade Chassis (HP C7000, HP C3000, and Dell M1000e) does not use hardware monitoring
agent software.
Vendor: HP Dell IB
For example: Navigating to https://10.186.16.100:1311 in your web browser will take you to
the Dell OpenManage Server Administrator page on the remotely monitored host.
Hardware Details
Once you have chosen the hardware you want to monitor, the Hardware Health Details group appears on
the Node Details page and looks similar to the following illustration, providing general information about
your hardware and its status:
239
This view will be hidden if hardware monitoring is disabled.
The current status of your hardware's health can be determined by the Current Hardware Health
grouping, as shown below. The status for most items will read OK, Warning, or Critical, depending upon
the set threshold values and the returned values. The icon colors for each item will change between green,
yellow, and red, respectively. Gray icons indicate a status of Unknown, which suggests a polling failure.
You can click on the [+] and [-] icons to expand and collapse a particular tree branch of hardware that is
being monitored. When collapsed, the top level view (or roll-up status) of each hardware item will display
the worst status of an item in that branch.
240
The default temperature measurement is in degrees, Fahrenheit (ᵒ F). To change this to Celsius (ᵒ C),
On the Web Console, click Settings > Manage Accounts > Select Account > Edit. The Temperature
Unit drop down menu can be found under the Server & Application Monitor Settings category.
This resource provides a status overview of your monitored hardware's health. Mousing over each pie
segment will provide a tooltip with more detailed information.
Clicking a server icon in the Overview Chart will bring up a list of the servers with the indicated status, as
shown below. From here, you can navigate to the Details page of each server by clicking any icon in the list.
Hardware thresholds can be enabled, disabled, or modified via the Manage Hardware Sensors screen.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Hardware Sensors.
2. To enable or disable objects from being monitored, select the objects, then click either Enable or
Disable.
3. To modify hardware thresholds, check the objects, then click Edit Thresholds.
4. Choose from the following three options:
a. Use Orion defaults: Use the built-in Orion logic for translating sensor reading to status.
b. Force to Up: Ignore sensor readings when calculating status. The status is always Up.
c. Set custom thresholds: Create your own logic for mapping sensor readings to Orion status.
Note: Threshold modification may not be available for certain objects where information is
not available.
d. Complete the logic form for both the Warning threshold and the Critical threshold as needed
to satisfy your requirements.
241
5. Click Submit.
Additionally, some values can be configured through the Hardware Monitoring Agent Software installed on
your hardware. Dell OpenManage Server Administrator is one such example. The illustration below shows
how threshold values for the temperature can be changed from the default values using Dell's software.
Different default thresholds exist for different items in the Hardware Monitoring Agent Software. Some of
these thresholds may be accessible and open to editing, some may not. Consult your Hardware Monitoring
Agent Software user guide for specific information about editing thresholds.
Different default thresholds exist for different items in the Hardware Monitoring Agent Software. Some of
these thresholds may be accessible and open to editing, some may not. Consult your Hardware Monitoring
Agent Software user guide for specific information about editing thresholds.
This chart allows you to visualize multiple hardware statistics simultaneously. The advantage of this view is
that you can easily see how your hardware objects are performing over a given period of time in relation to
one another.
Tabs at the top of the chart allow you to quickly navigate between different groups of hardware, allowing
you to see the performance and status of an entire group of the same hardware on a single page.
242
This view is hidden if hardware monitoring is disabled.
Click Edit at the top-right of the chart to be taken to the following screen. You can customize the following
user-specific aspects of the chart display:
n Sample Interval: This is the interval of time that will be displayed on the chart.
n Title: This will give a title to display for your chart.
n Subtitle: This will give a subtitle to display for your chart.
n Temperature Display: This allows you to set the temperature units. This will affect all charts that
display temperature for the current user.
n Time Period for Chart: This allows you to select the span of time the chart will display.
Clicking the chart itself opens a screen which allows you to edit settings pertaining to the Hardware
Chart. Click Submit to save the settings.
243
The Raw Data button will deliver the chart data by downloading an Excel spreadsheet. The Chart
Data button displays the data in a web page.
244
Monitor virtual infrastructure in the Orion Web Console
SolarWinds Integrated Virtual Infrastructure Monitor (IVIM) is the feature that enables
virtual monitoring directly from the Orion Web Console.
If your virtual machines are on monitored ESXi and ESX servers, VMware
Tools are not a requirement but provide access to additional
information, such as IP addresses.
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers
REQUIREMENT DESCRIPTION
SNMP must be enabled on all ESXi and ESX servers. For more
SNMP
information, consult your ESX or ESXi server vendor documentation.
245
REQUIREMENT DESCRIPTION
The following methods are used by SolarWinds Orion to monitor VMware ESX Servers
and their component features.
FEATURES 4 4i 5i 6.0
Total CPU
VMware API
(ESX details view)
Total memory
VMware API
(ESX details view)
246
Create ESX server credentials for SolarWinds Orion products
FEATURES 4 4i 5i 6.0
Guest VM list
VMware API
(ESX details view)
For polling performance data, you must create credentials on your ESX Servers for the
SolarWinds Orion polling engine.
To create the credentials, log in to the ESX server, and create a user. For more
information, consult your vendor documentation.
Credentials created for the polling engine must have read-only rights as a
minimum.
SolarWinds Orion uses SNMP to poll performance data from VMware ESXi and ESX
Servers. In order to make this performance data available to SolarWinds Orion, you
must enable SNMP on your ESXi and ESX Servers.
Note: VMware only makes a limited amount of information available to SNMP queries
for VMware ESXi and ESX Servers version 4.0 and higher. To access additional
information on these versions, NPM utilizes the VMware API.
Note: The vSphere command line interface (CLI) is required, but it is not packaged
with your ESXi Server. Download it from VMware, as indicated.
1. Download the VMware vSphere command line interface from the VMware
Download Center (http://downloads.vmware.com/d/).
247
2. Install the VMware vSphere command line interface.
3. Use the vSphere CLI to view your ESXi server SNMP settings, as indicated in the
following procedure:
a. In the Perl\bin directory of your vSphere installation, execute the
following script:
perl ..\..\bin\vicfg-snmp.pl --server ip_address –s
Notes:
l C:\Program Files\VMware\VMware vSphere CLI\Perl\bin is the
default location of the vSphere Perl\bin directory.
l Replace ip_address with the IP address of your ESXi server, and
replace cstring with the community string you are adding. For
most environments, the community string public should be
sufficient.
b. Enter an appropriate user name at the prompt.
Note: For most environments, root should be sufficient.
c. Enter the associated password at the prompt.
4. Use the vSphere CLI to enable SNMP on your ESXi server, as indicated in the
following procedure:
a. In the Perl\bin directory of your vSphere installation, execute the
following script to add an appropriate community string:
perl ..\..\bin\vicfg-snmp.pl --server ip_address -c cstring
Note: Replace ip_address with the IP address of your ESXi server, and
replace cstring with the community string you are adding. For most
environments, the community string public should be sufficient.
b. Enter an appropriate user name at the prompt.
Note: For most environments, root should be sufficient.
c. Enter the associated password at the prompt.
d. In the Perl\bin directory of your vSphere installation, execute the
following script to enable SNMP:
perl ..\..\bin\vicfg-snmp.pl --server ip_address –E
Note: Replace ip_address with the IP address of your ESXi server.
e. Enter an appropriate user name at the prompt.
Note: For most environments, root should be sufficient.
f. Enter the associated password at the prompt.
5. Reboot your ESXi server to allow settings to take effect.
248
Enabling SNMP on VMware ESXi and ESX Servers
1. Log in to your ESX Server using an account with administrative privileges, and
then open snmpd.conf in a text editor.
Notes:
l The default location for snmpd.conf is root/etc/snmp/snmpd.conf.
l To use the default text editor, nano, in a default ESX Server version 3.5
environment, enter nano /etc/snmp/snmpd.conf at the prompt.
2. Locate the rocommunity setting and replace the default community string
public with an appropriate read-only community string for your environment.
Note: Use commas to separate multiple community strings.
3. Save snmpd.conf, and then close your editor.
Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to
save snmpd.conf.
4. Enter chkconfig snmpd on to enable SNMP on when you reboot your ESX
Server.
5. Enter esxcfg-firewall -e snmpd to allow SNMP through the ESX Server
firewall.
6. Enter service snmpd start to start the SNMP service.
7. Confirm that SNMP polling is enabled on your ESX Server by entering the
following command:
snmpwalk -v1 -c cstring localhost .1.3.6.1.4.1.6876 | grep 6876.1
Note: Replace cstring with the community string you provided above.
8. After entering the snmpwalk command, your ESX Server should return
information similar to the following:
SNMPv2-SMI::enterprises.6876.1.1.0 = STRING: "VMware ESX
Server"SNMPv2-SMI::enterprises.6876.1.2.0 = STRING: "3.5.0"SNMPv2-
SMI::enterprises.6876.1.3.0 = OID: SNMPv2-
SMI::enterprises.6876.60.1.3.5.0SNMPv2-SMI::enterprises.6876.1.4.0 =
STRING: "153875"
249
Note: The MIB OID SNMPv2-SMI::enterprises.6876.1.4.0 returns the build
number for your product, so it may not be the same as the build number
displayed above.
The following procedure enables both the system default SNMP daemon snmpd and
the proprietary VMware SNMP daemon vmware-hostd on VMware ESX Server
version 4.0.
1. Log in to your ESX Server using an account with administrative privileges.
2. Open snmp.xml in a text editor.
Notes:
l The default location for snmp.xml is root/etc/vmware/snmp.xml.
l To use the default text editor, nano, in a default ESX Server version 4
environment, enter nano /etc/vmware/snmp.xml at the prompt.
3. Locate the communities tag, and then replace the default community string
public with an appropriate read-only community string for your environment.
Note: Use commas to separate multiple community strings.
4. Locate the enable tag, and then confirm it is set to true.
5. Locate the port tag and confirm it is set to 171.
6. Locate the targets tag and confirm it is set to 127.0.0.1@162/cstring.
Note: Replace cstring with the community string you provided above.
7. Save snmp.xml, and then close your editor.
Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to
save snmp.xml.
8. Enter service snmpd stop to confirm that the SNMP service is stopped.
9. Open snmpd.conf in a text editor.
Notes:
l The default location for snmpd.conf is root/etc/snmp/snmpd.conf.
l To use the default text editor, nano, in a default ESX Server version 4
environment, enter nano /etc/snmp/snmpd.conf at the prompt.
10. Edit snmpd.conf to include the following two lines:
view systemview included .1.3.6.1.4.1.6876
proxy -v 1 -c cstring 127.0.0.1:171 .1.3.6.1.4.1.6876
250
Edit VMware Credentials in the Orion Web Console
Note: Replace cstring with the community string you provided above.
11. Save snmpd.conf, and then close your editor.
Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to
save snmpd.conf.
12. Enter service mgmt-vmware restart to restart the mgmt-vmware service.
13. Enter service snmpd start to start the SNMP service.
14. Enter chkconfig snmpd on to enable SNMP when you reboot your ESX Server.
15. Enter esxcfg-firewall -e snmpd to allow SNMP through the ESX Server firewall.
16. Confirm that SNMP polling is enabled on your ESX Server by entering the
following command:
snmpwalk -v1 -c cstring localhost .1.3.6.1.4.1.6876 | grep 6876.1
Note: Replace cstring with the community string you provided above.
17. After entering the snmpwalk command, your ESX Server should return
information similar to the following:
SNMPv2-SMI::enterprises.6876.1.1.0 = STRING: "VMware ESX"SNMPv2-
SMI::enterprises.6876.1.2.0 = STRING: "4.0.0"SNMPv2-
SMI::enterprises.6876.1.4.0 = STRING: "208167"
Note: The OID SNMPv2-SMI::enterprises.6876.1.4.0 returns your product
build number, so it may not be the same as the build number above.
VMware has provided a document outlining the required steps to enable the native
SNMP agent on ESX Server version 5.0 and higher. For instructions on enabling the
native SNMP agent on VMware ESX Server versions 5.0 and higher, see the VMware
knowledge base article "Configuring SNMP Traps in ESXi/ESX (1008065)".
If credentials for a VMware account change on the device, update the credentials in
the Orion Web Console.
251
Add virtual servers for monitoring
Hyper-V nodes, VMware vCenter, ESX servers, and virtual machines which you want to
monitor must be added to the SolarWinds Orion database.
The Virtualization Summary view shows the overall status of your virtualized
infrastructure.
252
View ESX host details
Click an ESX Host server in the Virtualization Summary page to open the ESX Host
Details view.
If you did not provide the credentials within the Network Sonar Discovery, or when
adding the node to the database, assign credentials based on the server vendor.
1. Click Settings > All Settings > Manage Virtual Devices.
2. On the Virtualization Polling Settings page, select Hyper-V.
3. Select a Hyper-V server from the list, and click Edit Properties.
253
4. Under Polling Method > Windows Servers, choose a credential, or select New
Credential, and specify a new credential set.
5. Click Test to verify the credential set, and click Submit.
1. Click Settings > All Settings > Manage Virtual Devices.
2. On the Virtualization Polling Settings page, select VMware.
3. Select a VMware server from the list, and click Assign ESX Credential.
4. Choose an existing credential, or specify a new credential set.
5. Click Test to verify the credential set, and click Assign Credential to assign it to
the VMware server.
254
Monitoring Quality of Experience
On the Quality of Experience (QoE) dashboard you can monitor traffic on your network. QoE uses Packet
Analysis Sensor to provide packet-level traffic information about key devices and applications.
255
Benefits of QoE
n Compare statistics, such as network response time (TCP Handshake) and application response time
(Time to First Byte) to determine if a bottleneck is on the application or the network.
n Use data volume trends to pinpoint traffic anomalies and investigate the cause.
n Monitor risky types of traffic, for example, traffic that might bypass firewalls or lead to data leaks.
1. Deploy Packet Analysis Sensors (network, server, or both) to Windows nodes.
2. In the Orion Web Console, specify the nodes and applications for which you want to collect traffic.
Packet Analysis Sensors does not automatically discover nodes and applications. You must
indicate the nodes and applications to monitor before you will see traffic data in the web
console.
3. Allocate CPU cores and memory for the traffic load for each sensor.
Traffic data is captured using packet analysis sensors. These sensors collect packets using either a
dedicated Windows SPAN or Mirror port monitor or directly on your Windows server. Packet Analysis
Sensors capture packets from the local network interface (NIC) and then analyze collected packets to
calculate metrics for application performance monitoring. These metrics provide information about
application health and allow you to identify possible application performance issues before they are
reported by end-users.
With the ability to analyze packet traffic, QoE provides real observed network response time (NRT) and
application response time (ART). In addition, Packet Analysis Sensors can classify and categorize traffic for
over 1000 different applications by associated purpose and risk-level.
For more information about specific implementations of QoE, see Aggregation with access to network
(NPAS).
256
Quality of Experience requirements
Before you deploy a Packet Analysis Sensor to a device to monitor QoE, review the following minimum
system requirements.
Sensors cannot be installed on 32-bit computers and do not support communication over https.
HARDWARE/SOFTWARE REQUIREMENTS
Windows 7 or later, 64-bit
View your vendor documentation for instructions about how to set up port
mirroring. You can create port mirrors for both physical switches and virtual
switches.
HARDWARE/SOFTWARE REQUIREMENTS
257
HARDWARE/SOFTWARE REQUIREMENTS
258
Packet Analysis Sensor Licensing
QoE is available without limitation or license for SolarWinds Network Performance Monitor and SolarWinds
Server and Application Monitor.
259
Viewing Packet Analysis Sensor Licensing Details
QoE is available without limitation or license for SolarWinds Network Performance Monitor and SolarWinds
Server and Application Monitor.
260
Purchasing Additional QoE Licenses
QoE is available without limitation or license for SolarWinds Network Performance Monitor and SolarWinds
Server and Application Monitor.
261
Activating Additional Licenses
QoE is available without limitation or license for SolarWinds Network Performance Monitor and SolarWinds
Server and Application Monitor.
262
How SolarWinds Packet Analysis Sensors Work
SolarWinds provides two types of Packet Analysis Sensors to monitor and analyze your network traffic.
n Packet Analysis Sensors for Networks (network sensor) to collect and analyze packet data that flow
through a single, monitored switch for up to 50 discrete applications per node.
n Packet Analysis Sensor for Servers (server sensor) to collect and analyze packet data of specific
applications that flow through a single node.
After a sensor is deployed and configured, it captures packets and analyzes them to calculate performance
metrics for the monitored applications. An included communication agent allows the sensor to send back
sampled packet data to the Orion server, which includes volume, transactions, application response time,
and network response time for each application on a node. The packet data are then saved to the Orion
database. The information is used to populate your QoE dashboard. You can configure how long you retain
the packet data in the Database Settings section of the Polling Settings screen.
Your network administrator must create a dedicated SPAN, mirror port, or in-line tap monitor on the
physical or virtual switch before you can deploy or configure a network sensor.
After you deploy and configure the network sensor to the node monitoring the switch, the sensor captures
all packets that flow through the switch and categorize the packets by application.
Packets that correspond to monitored applications are analyzed for Quality of Experience metrics, such as
response times or traffic volume. Data is then sent to the Orion server using the SolarWinds
communication agent.
A SPAS captures packets to and from the node. It identifies packets that are sent to or from the monitored
application and analyzes them for Quality of Experience metrics, such as response time or traffic volume.
Data is then sent to the Orion server using the SolarWinds communication agent.
263
Limitations to Packet Analysis Sensors
The number of nodes you can monitor is limited by the data throughput per node, the number of cores,
and the amount of RAM available on the monitoring server.
264
Deploying Packet Analysis Sensors
After you install your Orion platform product, deploy network sensors on a server dedicated to monitoring
a network switch.
265
You can also deploy server sensors directly on physical or virtual servers, or workstations.
If you selected QoE during the installation, an agent is already on your SolarWinds Orion server
collecting data about applications that SolarWinds Orion is using.
Based on how you want to aggregate the returned QoE metrics, there are three main deployment
scenarios per sensor type.
Deploy an NPAS to a port mirror that monitors Add all of the endpoints to the
Per client
all traffic to and from the site NPAS as managed nodes
266
AGGREGATION LEVEL SENSOR DEPLOYMENT CONFIGURATION
I HAVE ACCESS TO MY APPLICATION SERVERS (SPAS)
Deploy the SPAS directly on the application
Per application Automatic
server
n When deploying both network and server sensors on the same network, ensure that you do
not monitor the same node with multiple sensors. This impacts the QoE metrics.
n All monitored nodes must be managed by your Orion Platform product before they can be
monitored by sensors.
n Applications and nodes are detected by default if the node is managed by your
SolarWinds Orion server. If packet data is not collected, navigate to Settings > All Settings, and
click on QoE Settings. Click Manage Global QoE Settings, and activate the auto-detect option.
You can also manually monitor applications and managed nodes or ignore them.
This deployment scenario provides a broad indication of the overall response time between computers
and the monitored application.
267
Aggregation with access to network (NPAS)
n Create a port mirror, SPAN, or network tap on the switch with all the network traffic to or from
the application.
n You can monitor multiple applications using the same NPAS.
268
Aggregation with access to application servers (SPAS)
This deployment scenario provides an aggregated response time per monitored site or network to the
application. For example, the response time from your Detroit office to your datacenter is one second, but
the response time from Boston to your datacenter is seven seconds. If you used the aggregation per
application deployment method, the response time for the application is four seconds.
This method requires you to identify users who best represent how the application is used. You then use
the users' computers as data points to monitor with Packet Analysis Sensors.
269
Aggregation per site with access to network (NPAS)
n Create a port mirror, SPAN, or network tap on the switch with all the network traffic to or from
the application.
n You can monitor multiple applications using the same NPAS.
n Identify a sample set of users whose computers are monitored by the NPAS.
270
Aggregation per site with access to application servers (SPAS)
Identify a sample set of users whose computers are monitored by the SPAS.
This deployment scenario provides highly granular response times for the application because metrics for
each computer are recorded.
One or two workstations can experience long response times, which may not be caught when aggregated
per site or per application.
This method requires all workstations to be managed within your Orion Platform product.
271
Aggregation per computer with access to network (NPAS)
n Create a port mirror, SPAN, or network tap on the switch with all the network traffic to or from
the application.
n You can monitor multiple applications using the same NPAS.
272
Aggregation per computer with access to application servers (SPAS)
273
Deploying a Network Sensor
n Data from sensors is directed to the polling engine assigned to the node when the sensor was
deployed.
n A high number of applications or nodes can cause performance issues with the sensors.
The network sensor must be installed on a Windows computer that is monitoring the switch's SPAN or
mirror port.
4. Move the node that monitors your switch to the Selected Nodes panel, and click Add Selected Nodes.
Make sure you select the Windows machine that is monitoring the SPAN or mirror port of the
switch.
5. Assign and test the credentials for the node, and click Submit.
6. Click Add Nodes and Deploy Agents.
Deploying the sensor and receiving the first set of data can take several minutes. When the
deployment is finished, select the sensor on the Manage Quality of Experience (QoE) Packet Analysis
Sensors page, click Edit Sensor, and verify the selected NIC.
274
Monitor website traffic based on domains
After you deploy a network sensor, you can filter application traffic based on domain names instead of all
http traffic.
4. Set the Auto-detect QoE applications option to Active, and click Submit.
QoE can automatically detect the first 50 applications, or you can add specific applications.
Discovered applications have the "No Risk" Risk Level and the "Both Business and Social" Productivity
Rating associated with them. To modify the Risk Level and Productivity Rating, click QoE Settings > Manage
(QoE) Applications, and edit the application.
Use the Global QoE Settings page to disable monitoring or discovery of multiple applications. Select
the applications, and click Disable Monitoring or Disable Discovery.
To specify manually which nodes and applications to monitor, see Monitor QoE Applications and Nodes.
Nodes are automatically detected and added by default.
275
Deploying a Server Sensor
These sensors monitor all the application traffic into and out of the server they are installed on.
After you deploy a server sensor to the application node, the sensor monitors packets to and from the
node, identifies the application or the URL, and analyzes the packets for QoE metrics, such as response
time or traffic volume.
4. Move the Windows nodes that will host the server sensors to the Selected Nodes panel, and click
Add Selected Node.
5. Assign and test credentials for each node, and click Submit.
6. Click Add Nodes and Deploy Agents. QoE auto-discovers the applications on the servers.
Notes:
n Deployment may take some time and will run as a background process.
n QoE automatically chooses settings, including the interface to capture traffic data and limits to
memory and CPU, during agent deployment. You can change these settings once deployment is
complete by selecting the sensor and clicking Edit.
n When installation is complete, a message is displayed in the notification bar.
n You can confirm the deployment status on the Manage QoE Packet Analysis Sensors page.
To specify manually which applications to monitor, see Monitoring QoE applications. Applications are
automatically detected and added by default.
276
Removing a Sensor
Removing a sensor from a node is a two steps process. First delete the sensor using the Web Console, and
then remove the communication agent directly from the node.
1. In the Orion Website Administration page, navigate to Settings > QoE Settings.
2. Click Manage QoE Packet Analysis Sensors.
3. Select the node.
4. Click Delete Sensor.
5. Click Delete when prompted.
277
Monitor QoE Applications and Nodes
By default, nodes and applications are automatically monitored by QoE when you deploy a Network or
Server Sensor. You can modify this behavior and automatically filter which nodes or applications are
monitored.
See Global QoE Settings for more information on how you can change these settings.
Server Sensors automatically monitor the top 50 applications on the node they are installed on
based on the global settings. You can change which applications are monitored after the sensor is
deployed.
278
Manage Global QoE Settings
You can control how Packet Analysis Sensors behave by changing the settings on this page. Settings are
distributed to sensors regularly when the agent is updated. You can manually update an agent from the
Manage Agents page.
QoE Applications
Control how you monitor QoE applications for both Network Packet Analysis Sensors and Server Packet
Analysis Sensors.
Use this to detect and monitor traffic associated with all applications that fulfill the auto-detection
rules defined on this page. This is active by default. You must select applications manually when this
option is disabled.
Note: If you automatically detect nodes, you should also automatically detect applications.
Further refine the applications that are monitored by choosing to monitor all application traffic
sources, traffic destinations, or all application traffic. Packet sources and destinations are based on
the source or destination IP address included in the packet.
n Transaction destinations (servers) - Monitor applications that receive traffic based on the destination
IP address of the packet.
n Transaction sources (client) - Monitor applications that generate traffic based on the source
IP address of the packet.
n Either a source or destination - Monitor all application traffic.
For each node, include top X application that have at least Y% of total QoE traffic.
Filter the number of applications that are monitored to applications that generate a certain amount
of network traffic.
Control how you monitor QoE nodes for Network Packet Analysis Sensor.
279
Auto-detect QoE nodes
Use this to detect and monitor the first 50 nodes with network traffic. This is active by default. You
must select nodes manually when this option is disabled.
Note: If you automatically detect nodes, you should also automatically detect applications.
Further refine the nodes that are monitored by choosing to monitor all nodes that are traffic sources,
traffic destinations, or all nodes that generate or receive network traffic. Packet sources and
destinations are based on the source or destination IP address included in the packet.
n Transaction destinations (servers) - Monitor nodes that receive traffic based on the destination
IP address of the packet.
n Transaction sources (client) - Monitor nodes that generate traffic based on the source IP address of
the packet.
n Either a source or destination - Monitor all traffic.
280
Monitoring QoE applications
Applications are automatically monitored when traffic is detected by the Packet Analysis Sensor. However,
you can manually select specific applications to monitor. QoE installs with the ability to monitor over 1000
pre-defined applications, including FTP, RDP, CIFS, SQL, and Exchange. You can also define your own
custom HTTP applications.
Notes:
n Because of the hardware requirements needed to process large amounts of traffic, SolarWinds
recommends that you preferentially monitor business-critical nodes and applications. For more
information about recommended hardware specifications, see Quality of Experience requirements.
n You should not assign more than 50 applications to a single node due to potential performance
issues. However, you can monitor up to 1000 applications.
While QoE sensors automatically detect and monitor applications by default, the settings may have
changed or you may have upgraded from a previous version of QoE that does not automatically monitor
applications.
Note: Only applications that meet the criteria selected in QoE Applications are monitored automatically.
281
4. Click Manage QoE Applications.
Notes:
n Applications are only listed if there are monitored nodes. You must first add a Network or
Server Sensor before you can enable any applications. For more information, see Aggregation
with access to network (NPAS).
n Applications listed with the Enabled/Disabled toggle "ON" are currently being monitored on
at least one node.
n Applications can be disabled (the Enabled/Disabled toggle "OFF") which means that no traffic
for the application is currently collected on any node.
5. Click Add New .
6. Select Choose a pre-configured application.
Note: Applications that are already enabled will not appear in the list.
7. Use the Search or Group By options to find the application you want to monitor, select it, and then
click Next.
8. On the Configure Application view, edit the Category, Risk Level, or Productivity Rating as
necessary, and then click Next.
9. On the Configure Data Collection view, choose the node(s) you want to monitor for this type of
traffic.
Note: Only nodes that have already been specified as nodes to monitor on the Manage QoE Nodes
page appear in this list.
10. Click Next.
11. Review your choices on the Summary page, then click Finish.
Your newly enabled application will appear on the Manage QoE Applications page in alphabetical order.
282
Defining nodes for a network sensor
Nodes are automatically detected and monitored when network traffic is detected either originating from
or terminating at a node. However, you can manually specify the nodes instead. After the network sensor
has been successfully deployed, add applications and nodes to monitor. For information about adding
applications, see Monitoring QoE applications.
While Network Sensors automatically detect and monitor nodes by default, the settings may have changed
or you may have upgraded from a previous version of QoE that does not automatically monitor nodes. QoE
automatically monitors the first 50 nodes with traffic.
Notes:
n Automatic node discovery may not be 100% accurate due to devices with the same IP addresses in
your network.
n Only nodes that meet the criteria selected in Nodes with QoE Traffic are added automatically.
You may choose to add monitored nodes manually to a Network Sensor. If a node is already monitored and
you want to monitor it with a different sensor, you must delete the node from the original sensor before
you can add it to the new network sensor.
283
4. On the Create QoE Node page, choose the managed nodes you want to monitor with this network
sensor.
5. Click Next.
6. On the Select QoE Applications page, choose the applications you want to monitor for these nodes.
See Monitoring QoE applications for more information.
7. Click Next.
8. Review your selections on the Summary page.
9. Click Finish.
View the nodes and applications selected by expanding the Network Sensor you just configured.
284
Ignoring applications or nodes
Ignoring applications
If you decide that you no longer want to monitor an application, you can disable discovery or monitoring
for that application in the Manage QoE Applications page.
Note: These settings are on a global level. You cannot turn application discovery or monitoring on or off for
specific sensors.
Use the following table to determine which combination of settings you want to use.
Ignoring nodes
You can permanently ignore all traffic from specific nodes that you monitor on a network sensor. This is
often used to reassign a node to a different network sensor.
285
3. In the Settings grouping, click QoE Settings.
4. Click Manage QoE Packet Analysis Sensors.
5. Select a network sensor, and click Edit.
6. Select the node you want to remove, and click Delete.
286
Defining Custom HTTP Applications
In addition to choosing from pre-defined applications, you can also define custom HTTP applications, and
then add them to nodes you are monitoring.
For example, selecting Hostname contains changes the help text to http://*...*/path/pageCore--
sw5.html. Any text you enter will be included in the filter where the “…” appears.
6. Enter the hostname or URL for your filter, then click Next.
7. On the Specify Nodes page, choose the node(s) you want to monitor for this type of traffic. Only
nodes that have already been specified as nodes to monitor (on the Manage QoE Nodes page) will
appear in this list.
8. Click Next. Review your choices on the Summary page, then click Finish.
9. Your new application will appear on the Manage QoE Applications page in alphabetical order.
287
Advanced Sensor Configuration
Sensors cannot be edited until they are fully deployed. You are notified when your sensor is deployed, or
you can check the Manage QoE Packet Analysis Sensors page. The status of completely deployed and
working sensors is Up.
288
Configuring the Monitored Interface
When you deploy a sensor, the first available interface is monitored for traffic. Once the sensor is installed,
you can go back and change the monitored interface, as indicated in the following procedure.
1. Click Settings > QoE Settings > Manage QoE Packet Analysis Sensors.
2. Select the sensor to edit.
3. Click Edit Sensor.
4. Select the desired interface from the Interface to capture QoE data drop-down list.
5. Click Save.
289
Configuring the Number of CPU Cores and Allocated Memory
When a sensor is deployed, QoE automatically allocates one CPU core and 256 MB of memory to the
sensor. After the sensor is installed, you can change the allocated CPU cores and memory.
For sensors, the memory usage scales with the traffic load. The more flows that are going on the line, the
more memory you need.
NUMBER OF
CPU CORES GUIDELINES
1 Not Recommended
1. Click Settings > QoE Settings > Manage QoE Packet Analysis Sensors.
2. Select the sensor to edit.
3. Click Edit Sensor.
4. In the Memory field, select the number of GB you want to allocate to the sensor.
Note: If you allocate less than the recommended amount of memory, you may see reduced
performance.
5. In the CPU Cores field, select the number of CPU cores you want to allocate to the sensor.
Note: If you allocate fewer than the recommended number of CPU cores, you may see reduced
performance.
6. Click Save.
290
Configuring Thresholds
You can modify the application response time (ART), network response time (NRT), volume, and transaction
thresholds that are used to alert you to irregularities in your network.
Note: It is best to allow the sensors to collect a few days' worth of data before setting thresholds.
To change the number of CPU cores and memory allocated to the sensor:
291
Packet Analysis Sensor Agents
The software that provides a communication channel between your SolarWinds server and the monitored
object to which you have deployed your Packet Analysis Sensor is called an agent. Agents are used to
provide packet-level traffic information about key devices and applications that you specify. The agent
runs as a service, and it has a relatively small footprint (under 100MB installed).
n Agent requirements
n Windows agent deployment
n Agent settings
n Manage agents, connections, and deployment status
292
SolarWinds Orion agents
An agent is software that provides a communication channel between the Orion server and a Windows or
Linux computer. Agents are used to provide information about key devices and applications that you
specify. This can be beneficial in the following situations:
You can monitor servers hosted by cloud-based services such as Amazon EC2, Rackspace, Microsoft Azure,
and other Infrastructure as a Service (IaaS).
After deployment, all communication between the SolarWinds Orion server and the agent occur over a
single fixed port. This communication is fully encrypted using 2048-bit TLS encryption. The agent protocol
supports NAT traversal and passing through proxy servers that require authentication.
293
Agent settings
The Agent Settings page provides access to all of the settings and tools needed to install and manage
agents. Additional agent settings can be found in the Windows Control Panel.
n Allow automatic agent registration: Select this option to automatically register the agent and verify
communication with the Orion Server. If this option is disabled, you can register any waiting agents
by clicking Settings > All Settings > Manage Agents > Add Agent > Connect to a previously installed
agent.
n Automatically create node: Agents are automatically registered as Orion nodes.
n Allow automatic agent updates: Select this option to automatically upgrade the agent software when
updates are available. This process pushes a new version of the agent to client computers over the
agent communication channel. No extra ports or permissions are needed. Once the agent receives
the new version, it updates itself. This process does not require rebooting.
If automatic updates are disabled and a new version of the software is installed on the server,
outdated agents may not be able to communicate with the server. Ensure all agent versions
match the version of the server.
n XX Hours: Control the length of time the agent displays as being new in the Manage Agents list.
294
Server-initiated communication
All communication between your SolarWinds Orion server or additional polling engine and the agent is
initiated by the server, and the agent does not initiate communication to your SolarWinds Orion server.
You must have a direct route from the server with the agent installed to your SolarWinds Orion server or
additional polling engine. To use this communication method, port 17790 must be open on the firewall of
the remote host to retrieve information from the agent.
295
Agent-initiated communication
All communication between your Orion server or additional poller and the agent is initiated by the agent,
and your SolarWinds Orion server does not initiate communication with the agent. You do not need to
have a direct route from the server with the agent installed to your SolarWinds Orion server or additional
poller. To use this communication method, port 17778 must be open on the SolarWinds Orion server
firewall to receive information from the agent.
This communication method is most useful when the agent is installed on a network separated from your
Orion server by one or more NAT devices, and you have no easy way to connect the two.
296
Windows agent deployment
SolarWinds Orion products supports three methods of deploying an agent to a client computer running
Windows.
n Push the agent software from the Orion Server to one or more client computers.
n Mass deploy the agent software to multiple computers using a mass deployment technology, such as
Group Policy.
n Manually install the agent on a client computer.
Agents do not work with AppInsight for SQL when the SQL Server being monitored is in a cluster.
297
Deploy Windows agent software via server push
Select this method of deployment to perform a network-wide deployment from the SolarWinds Orion
server. This method does not require downloading additional files. In order for this deployment method to
succeed, the SolarWinds Orion server must be able to communicate with the client computers.
1. On the Deploy Agent on Network page, enter the IP address or host name of the Windows computer
where you want the agent to be installed, or select nodes from the list, and then click Next.
This field does not accept ranges. Only add computers that are not nodes in the system.
When the connection is successful, the agent displays in the agent list on the Manage Agents page.
Select this method to connect to agents that were configured with server-initiated communication, or if
Allow Automatic Agent Registration is not enabled. When you connect to an agent, you first need to select
the communication mode that was chosen when the agent was installed. If the communication mode is
server-initiated (passive), a shared secret was required during installation. This secret must be entered
again here.
1. On the Add Agent page, enter a name for the Agent.
2. Select the agent communication mode.
3. For Server-initiated communication:
a. Enter the IP address or hostname where the agent is located.
b. Enter the shared secret.
c. Optional: Expand Advanced and adjust the following settings as needed:
a. Change the agent port number. This is the port the agent uses for listening.
b. Use a proxy. Selecting a proxy and enter the proxy URL.
c. Use proxy authentication, and enter credentials.
4. For Agent-initiated communication, select the agent from the Agent list.
298
5. Select Allow automatic agent updates to upgrade the agent automatically when upgrading to new
versions of Orion Platform modules that support the agent.
Disabling this option requires you to manually upgrade agents after upgrading your Orion
Platform products.
299
Deploy the Windows agent manually
Selecting this method of deployment may be helpful in troubleshooting connectivity issues with another
form of agent deployment. This method is also helpful when the Orion server cannot communicate directly
with the endpoint where the agent will be installed, such as in the case of Active Agent mode.
When installation is successful, the agent displays in the agent list on the Manage Agents page.
300
Mass deploy a Windows agent
If you are already using a mass-deployment technology, this deployment method is an easy way to get
agents on a large number of computers.
Polling engine selection is important. When you click Download .MST, the MST file created includes the
polling engine IP address and other vital information. When you deploy the agent using the MSI file, along
with the MST file on the managed node, the agent will be installed and pointed to the correct polling
engine.
1. Copy the MSI and MST files to a shared network location that is accessible to the hosts where you
want to deploy the agent software.
2. Configure the permissions on the shared location to ensure that all required users and computers
have Read access to the installation files.
3. Locate the container in Active Directory (a site, a domain, or an organizational unit (OU)) where you
want to advertise the application and access the container properties.
4. Add the modification for the application package. For more information, search for "Add or remove
modifications for an application package" at technet.microsoft.com.
5. After you complete the setup, the agent is deployed and registered by Orion (if auto-registration is
enabled as defined in the Agent settings page).
301
When the installation is successful, the agent displays in the agent list on the Manage Agents page.
A Microsoft Transform (MST) file is a collection of specified changes applied to a base Windows Installer
package file at the time of deployment. It is an overlay on top of an existing MSI file that defines what
specific components or features of an application get installed. The MST file modifies the Microsoft
Installer package.
After the software you want to install is packaged in the Windows Installer package format, you can use
MST files to customize the software for your organization, such as installing only specific features. The
modular design of Windows Installer packages simplifies deployment. When you apply transforms to an
MSI file, Windows Installer can dynamically add or modify data in the installation database to customize
the installation of the application. Additional information on creating MST files can be found on
technet.microsoft.com.
The agent is deployed at login and is registered by Orion (if auto-registration is enabled).
302
Deploy with a Gold Master Image
Use a Gold Master Image when you want to maintain a master image that is copied when a new server is
provisioned. This is useful for virtual machines, physical servers, and cloud instances. Whenever a new
server is brought online using this image, the agent will already be installed.
303
Deploy a Windows agent with Patch Manager
You can only perform this deployment method if you have successfully configured Patch Manager to push
software in your environment.
Record the Latest Version value under the MSI file download. This is needed when creating a
package in Patch Manager.
Optional: Rename the SolarWinds agent files to SolarWinds Agent <version> for easier
tracking.
3. From the SolarWinds, Inc. Packages action pane, click New Package. This launches the Patch Manager
Package Wizard.
304
4. In the package information screen, enter the following general information for the package:
n Package Title: SolarWinds Orion Agent (version number) MSI
n Description: SolarWinds Orion Agent
n Classification: Tools
n Vendor: SolarWinds, Inc.
n Product: Orion Agent (This must be entered the first time)
n Severity: None
n Impact: Normal
n Reboot Behavior: Can request reboot
All other fields can be left empty.
305
6. The GUID product code is extracted from the MSI file and displayed for review. Copy the GUID
product code that you will use later.
The GUID is detected from the installer. Use the one displayed in your environment.
7. Select Includes additional files with the package, and click the button to the right to open the
Package Content Editor.
8. In the Package Content Editor, click Add Files, and browse to the MST File for the SolarWinds Orion
agent.
9. Click OK to close the Package Content Editor. To confirm that you want to add these files to the cache,
click Yes.
10. Select None for the Binary Language.
11. In the Command Line field, enter: TRASNFORMS=(MST FILE NAME)
Example: TRANSFORMS=SolarWinds_Agent_1.5.0.951.mst
306
19. Click OK to save the rule, and click Next. Review the Summary Page, and enter notes at the bottom.
20. Click Next to save, and click OK.
When the file packaging and uploading completes, a Package Saved dialog displays.
1. In the SolarWinds, Inc. Packages view in Patch Manager, select the SolarWinds Orion Agent package
that you created.
2. In the SolarWinds Orion Agent action pane, click Publish Packages.
3. Accept the default selections, or choose a specific Windows Server Update Services (WSUS) server for
publication, and then click Next.
4. You are notified when the package publishes.
5. Click Finish to close the Publishing Wizard.
The package for the SolarWinds Orion agent is packaged and published to your WSUS server.
307
Deploy on Windows Core Servers
If you are installing the agent on a Windows Core Server, you must install the .NET Framework 4.0. Also
install the latest Windows service pack and critical updates.
n Start WoW64.
n Start the .NET 2.0 layer.
n Start the .NET 2.0 layer for WoW64.
n Download and install the .NET framework from www.microsoft.com.
By default, no web browser is installed with Windows Core. Consider transferring the necessary files
with FTP or a flash drive.
Once the .NET Framework is installed, you may need to reboot the host server. The agent can then be
deployed to the host server and operate normally.
308
Deploy Windows agents in the cloud
Agents can be deployed in the cloud for use with Amazon Web Services, Microsoft Azure, and other third-
party cloud infrastructure services.
309
Manually deploy a Windows agent on Amazon Web Services
You can manually deploy agents to a virtual machine using Remote Desktop Connection.
310
Automatically deploy a Windows agent on Amazon Web Services
You can perform the following steps through the API or AWS command line interface.
10. Create an instance, and paste your PowerShell script under Advanced Details in the User Data text
box. Select the As Text option.
11. For instances that are already created, take the following steps:
a. Stop the instance where you want to deploy the agent
b. Right-click the instance and click Instance Settings > View/Change User Data.
c. Paste you PowerShell script in the text box as Plain Text.
311
Automatically deploy a Windows agent on Microsoft Azure
This step can also be accomplished via the API or AWS command line interface.
312
Certificates and the agent
The Verisign Root Certificate Authority (CA) must be current. This is required because the agent software is
signed using a Verisign certificate. If your certificate is not current, you must download the Root CA
certificate and install it to the Local Computer\Trusted Root Certification Authority store on
the server hosting the agent.
For more information, search for "Add the Certificates Snap-in to an MMC" at technet.microsoft.com.
313
Manage agents, connections, and deployment status
Check agent connection and deployment status on the Manage Agents page.
n Add Agent: Takes you to the Add Agent page, where you can deploy the agent on a network, or
connect to a previously installed agent.
n Edit Settings: Takes you to the Edit Agent Settings page, where you can adjust the agent name and
automatic updating.
n Delete: Deleting an agent from within this toolbar or the Manage Nodes page provides you the
option to remotely uninstall the agent.
n Choose Resources: Displays a list of resources and statistics to monitor. This is only available for
agents that are deployed on nodes.
n For a Single Agent: Takes you to the List Resources page to choose items on the node you wish
to monitor.
n For Multiple Agents: From here, SolarWinds Orion discovers available resources on the agents
you have selected using Network Sonar Discovery. You can choose items on the nodes you wish
to monitor.
n Manage as Node: This will manage the agent as a new node by navigating to the Add Node page
with pre-configured agent details.
n More Actions:
n View installed agent plug-ins: Displays a dialog detailing the node the agent is deployed on,
the agent status, connection status, plug-in status, and plug-in version.
n View installed plug-ins report: Generates a report detailing the following: Node Status, Agent
DNS Name, Automatic Update enabled, Connection Status, Agent Status, Agent Version, Plugin,
Plugin status, and Plugin Version.
n Retry agent installation: Attempts to install the agent in the event of a file transfer timeout due
to network connectivity issues.
n Reboot Agent Machine: Reboots the server that hosts the selected agent.
n Reconnect to passive agent: The server tries to re-establish the connection to the passive agent
when the connection is lost and automatic reconnection fails. This can also be used for
connecting to an agent that was deleted but not uninstalled.
314
Manage Agents table columns
Registered On Date when the agent was added to the agent management system.
315
COLUMN HEADER DESCRIPTION
n Server-initiated: The agent behaves as a web server and the agent
management system initiates the connection.
Version of the agent software. This is helpful in determining which agents should be
Version
updated.
316
Edit agent settings
Editing the configuration of an agent may be necessary if you experience problems and want to collect
diagnostics.
317
Track your polling method
If nodes are using different polling methods, you may want to keep track of the polling method of each
node to troubleshoot issues more easily. There are several methods you can use to identify the polling
method of nodes:
318
View the status of agent plug-ins
STATUS MEANING
The plug-
in is The plug-in is installed, working correctly, and communicating with no problems.
installed
The plug-in is waiting to be deployed. It may be waiting for the computer it is installed on to
Installation
reboot, or because some other process on the remote host has interrupted the installation
Pending
process.
The status is unknown due to networking interruptions, communication problems with the
Unknown
agent, or because the plug-in is no longer installed.
If you think a plug-in should be available and cannot find it in the list, you may need to check your
purchased products or manually update your agent. New plug-ins and updates to existing plug-ins are
installed when an agent is updated. It may take a few minutes before the status changes.
319
Edit agent settings in the Windows Control Panel
If the agent loses connectivity to the SolarWinds Orion server, or is unable to connect after being manually
installed, you can configure its settings in the Windows Control Panel. This enables the agent to reconnect
to the SolarWinds Orion server.
The Agent Shared Secret is provided for security. When you install the agent, you must set a
shared secret. When the SolarWinds Orion server connects to the agent, it verifies the secret
to connect.
320
Connect to a previously installed agent
You can connect to agents that you installed previously or modify the assigned polling engine of the agent.
The steps are different depending on the agent communication mode. You should confirm the agent
communication mode before connecting.
Disabling this option requires you to upgrade agents manually after upgrading your
SolarWinds products and modules.
Disabling this option requires you to upgrade agents manually after upgrading your
SolarWinds products and modules.
321
Change agent communication modes
When you want to change how the agent communicates back to the SolarWinds Orion server, you must
uninstall and redeploy the agent with the new communication method. Ensure that you loose as little data
as possible, and prevent alerts or node down notifications, by changing the polling method before you
remove the agent.
322
Change the agent port
1. On the computer with the deployed agent, edit the following configuration file using a text editor:
C:\Program Files (x86)
\SolarWinds\Orion\AgentManagement\SolarWinds.AgentManagement.ServiceCore.dl
l.config
2. Change the port number on the following line:
<agentManagementServiceConfiguration messagingPort="17778" />
3. Save the file.
4. Restart the SolarWinds Orion Module Engine service.
n If you installed the agent manually, you can change the port number during installation
through the wizard in the web console.
n If you deployed the agent from the server, the port number is set automatically.
n If you used the MST file for mass deployment, you must download a new MST file from the
server after you change the port number.
323
Agent polling method
An agent is software that provides a communication channel between the Orion server and a Windows or
Linux computer. Agents are used to provide information about key devices and applications that you
specify. For more information about the polling method, see Choose the polling method to use.
When the Agent Polling Method is selected, an agent is deployed to the node and installed using the
credential you selected. After the agent is installed, it operates under a local account.
324
Check nodes polling with agents for changes
Agent discovery has an option to keep nodes updated that use agents. Select this option so the Orion
server can find new volumes, interfaces, and other objects on nodes that are polled by an agent.
While normal discovery finds new nodes and adds them to the SolarWinds Orion server, this is not true for
nodes using the agent. Agent discovery is an extension to the standard discovery process.
325
View network events in the Web Console
All events that occur to monitored devices on your network are automatically logged and displayed in the
Orion Web Console. You can view and remove them as your network management policies require.
326
Filter the displayed logged events in the Web Console
Network events are logged and shown in the order they occur in the Events view of the Orion Web Console.
You can choose how long network events are kept in the Events Retention field in Orion Polling
Settings under Database Settings.
1. Click Events in the Views toolbar in the Orion Web Console.
2. Filter events by object, event type, or time period.
3. In the Show X Events field, provide the maximum number of events to view. Showing a large number
of events, such as a 1000, can negatively impact performance.
4. To show events that have already been cleared, select Show Cleared Events.
5. Click Refresh.
327
Remove events from the Web Console
Cleared events are not removed from the event log and can still be used for reporting.
Syslog messages are received by the SolarWinds Syslog Service, which listens for incoming messages on
UDP port 514. Received messages are decoded and stored in the SolarWinds Orion database. The
SolarWinds Syslog Service can handle large numbers of simultaneously incoming Syslog messages from all
your monitored devices.
A SolarWinds installation can process approximately 1 million Syslog messages per hour, which is
about 300 Syslog messages per second. You can process more by increasing your hardware
requirements over the minimum requirements.
You can view Syslog messages in the Orion Web Console or in the Syslog Viewer application.
n Confirm that your network devices are configured to send Syslog messages to the SolarWinds Orion
server IP address. For proper configuration of network devices, refer to the documentation supplied
by the device vendor.
n Ensure UDP port 514 is open for IPv4 and IPv6.
n The message must be formatted according to the Request for Comments (RFC) requirements.
n If a long message is split into smaller parts, these parts should be formatted to not be skipped.
SolarWinds recommends setting up Enable RFC Relay in the service to true to allow the
service to restructure the message by adding the default facility, severity, or date.
328
Configure the SolarWinds Orion server to use the correct syslog port
By default, SolarWinds Syslog Service listens for syslog messages on port 514 (UDP). If your devices use a
different port for sending syslog messages, consider reconfiguring the port on devices, or change the port
on which the service listens.
If you run the Configuration Wizard, you must repeat this procedure to restore the port setting.
At the beginning of each Syslog message, there is a priority value. The priority value is calculated using the
following formula:
Syslog facilities
The facility value indicates which machine process created the message. The Syslog protocol was originally
written on BSD Unix, so Facilities reflect the names of UNIX processes and daemons.
If you are receiving messages from a UNIX system, consider using the User Facility as your first
choice. Local0 through Local7 are not used by UNIX and are traditionally used by networking
equipment. Cisco routers, for example, use Local6 or Local7.
329
NUMBER SOURCE NUMBER SOURCE
Syslog severities
The following table provides a list of Syslog severity levels with descriptions and suggested actions for
each.
330
NUMBER SEVERITY SUGGESTED ACTIONS
4 Warning Warning messages are not errors, but they indicate that an error will occur
if required action is not taken. An example is a file system that is 85% full.
Each item must be resolved within a given time.
5 Notice Events that are unusual but are not error conditions. These items might be
summarized in an email to developers or administrators to spot potential
problems. No immediate action is required.
331
Syslog facilities
The facility value indicates which machine process created the message. The Syslog protocol was originally
written on BSD Unix, so Facilities reflect the names of UNIX processes and daemons.
If you are receiving messages from a UNIX system, consider using the User Facility as your first
choice. Local0 through Local7 are not used by UNIX and are traditionally used by networking
equipment. Cisco routers, for example, use Local6 or Local7.
Syslog severities
The following table provides a list of Syslog severity levels with descriptions and suggested actions for
each.
332
NUMBER SEVERITY SUGGESTED ACTIONS
4 Warning Warning messages are not errors, but they indicate that an error will occur
if required action is not taken. An example is a file system that is 85% full.
Each item must be resolved within a given time.
5 Notice Events that are unusual but are not error conditions. These items might be
summarized in an email to developers or administrators to spot potential
problems. No immediate action is required.
The Syslogs view displays a list of all the Syslog messages generated by monitored network devices. The
messages are listed by time of transmission, with the most recent at the top of the list.
1. Log in to the Orion Web Console, and click Alerts & Activity > Syslog in the menu bar.
2. To filter Syslog messages so that only messages relevant for specific devices are displayed:
n To view messages for a specific Syslog-enabled network object, select it in the Network Object
list.
Only objects that have sent a Syslog message to the Orion server will be listed in this
field.
n To view messages for a specific device, provide the IP address in the IP Address field.
n To view messages for a specific device type, select it in the Type of Device list.
n To view messages for a specific vendor, select the vendor in the Vendors list.
333
3. To select which Syslog messages should be displayed:
n To view only messages with a severity, select the severity. See Syslog severities.
n To view messages for a facility, select the facility. See Syslog facilities.
n To view messages of a type, type the string into the Message Type field.
n To view only messages containing a pattern, provide the string in the Message Pattern field.
You can use the following wildcards:
Asterisk (*)
Use * before or after the pattern string if the provided pattern is not the
beginning, the end or the full message.
Underscore (_)
Use _ as a placeholder for one character.
n To view Syslog messages from a specific period of time, select either a period of time or enter
custom Beginning and Ending Date/Times.
n Type the number of Syslog messages you want to view into Number of Displayed Messages.
n To view cleared and acknowledged Syslog messages, select Show Cleared Messages.
4. Click Refresh to update the Syslog messages list with your settings.
Syslog messages matching the selected criteria display in a list beneath the search area.
Click Hide or Show in the top-right corner of the view to remove or restore the Syslog messages
search criteria area.
Click the Hostname or Message to open the Device Details view for the device.
To print the resulting list, click Printable Version.
The messages are cleared. You can see cleared messages when you select the Show Cleared Messages
box.
Syslog Viewer collects Syslog messages from your network and presents them in a readily reviewable and
searchable list so that you can easily monitor your network.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Syslog Viewer.
2. Click View > Current Messages.
3. Acknowledge current messages:
n Right-click any message, and select Acknowledge Selected.
n Add an Acknowledged column to the Syslog Viewer, and select the messages that you want to
acknowledge. See Configure Syslog Viewer.
334
Search for Syslog messages in the Syslog Viewer
In the Syslog Viewer, you can search through collected Syslog messages and format search results.
You can acknowledge messages both in the search results and in the Current Messages view.
See Configure Syslog Viewer.
5. To limit the number of displayed message, enter or select a number in the Maximum Number of
Messages to Display field.
6. To view messages that meet your search criteria as they arrive, select a number for the Auto Refresh
Every number of seconds field.
Auto Refresh is only available when you are viewing current messages. The Date/Time Range
must be set to Today, Last 24 Hours, Last 2 Hours, or Last Hour.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Syslog Viewer.
2. Click File > Settings.
3. Click the General tab in the Syslog Server Settings window.
4. Adjust the Maximum Number of Messages to Display in Current Messages view slider to set the
number of messages you want to display.
5. To Automatically Refresh the Current Messages View, select the option, and set the refresh rate with
the middle slider.
6. Adjust Retain Syslog Messages for How Many Days to set the length of time Syslog messages should
stay in the database.
Acknowledging Syslog messages is easier if you add the Acknowledged column to your view.
9. To wrap Syslog message text in the Current Messages view, select Word Wrap Long Messages.
10. If you do not expect to use the Syslog Viewer as your primary viewer for Syslog messages, select the
Message Parsing tab, and select what should be removed:
n Remove embedded Date/Time from Syslog Messages
n Remove Message Type from Syslog Messages
n Remove Domain Name from DNS Lookups.
335
Removing the added data from each record helps you reduce the size of your SolarWinds
Orion database.
The Syslog Viewer can trigger alerts when received Syslog messages match defined rules.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Syslog Viewer.
2. Click File > Settings.
3. Click Alerts/Filter Rules.
4. To create a rule, click Add New Rule.
5. To edit a rule, select the rule, and click Edit Selected Rule.
6. On the General tab, complete the following steps:
a. Provide or edit the Rule Name.
b. Select Enabled.
c. Select the servers from the Apply this Rule To list.
d. Enter the IP addresses or subnets to which this rule applies in the Source IP Addresses area.
7. To limit the rule only to messages from specific hosts, domains, or host name patterns, click the DNS
Hostname tab, and enter a DNS Hostname Pattern.
Enabling Time of Day checking creates more overhead for the CPU.
11. To suppress alert actions until a specified number of messages arrive that match the rule, complete
the following procedure:
a. Select the Trigger Threshold tab, and select Define a Trigger Threshold for this Rule.
b. Enter option values.
When Suspend Further Alert Actions For is selected, alert actions are not sent until the
specified amount of time has expired. When the time period expires, only new alerts are
sent. All alerts suppressed during the time period are discarded.
336
12. Configure Syslog alert actions on the Alert Actions tab:
a. To create an action for the rule, click Add New Action.
b. To edit an action for the rule, select the action, and click Edit Selected Action.
c. Configure the action.
Syslog alerts use a unique set of variables.
d. To delete an action, select the action, and click Delete Action.
e. Use the arrow buttons to set the order in which actions are performed.
Actions are processed in the order listed, from top to bottom.
f. Click OK to save all changes and return to Syslog Viewer Settings.
13. Use the arrow buttons to arrange the order in which the rules are applied.
Rules are processed in the order they appear, from top to bottom.
The Syslog message forwarding action allows you to forward received Syslog messages. Additionally, if you
have WinPCap version 3.0 or later installed on your SolarWinds Orion server, you can forward Syslog
messages as spoofed network packets.
The following procedure assumes you are editing a Forward the Syslog Message alert action. For
more information, see Configure received Syslog messages to trigger alerts.
1. Provide the hostname or IP address of the destination to which you want to forward the received
Syslog message.
2. Provide the UDP Port you are using for Syslog messaging.
3. Specify what IP address should be used for the source device in the syslog message. By default, the
device IP is replaced by the SolarWinds Orion server IP address.
a. To designate a specific IP address or hostname as the Syslog source, select Retain the
Original Source Address of the Message, select Use a Fixed Source IP Address, and provide
the IP address or hostname.
b. To keep the original IP address of the Syslog source device, select Retain the Original Source
Address of the Message, select Spoof Network Packet, and select the Network Adapter.
4. Click OK to complete the configuration.
If you monitor a large number of devices, where each device may have many connected objects of its own,
requesting information from each device is impractical. You can set up the SNMP Trap Server, and each
managed device can notify it about any issues by sending a trap message.
SNMP traps are received by the SolarWinds Trap Service, which listens for incoming trap messages on UDP
port 162, and then decodes, displays, and stores the messages in the SolarWinds Orion database.
337
The SolarWinds Trap Service can receive and process SNMP traps from any type of monitored network
device, and can handle large numbers of simultaneously incoming traps.
A SolarWinds installation can process approximately 500 traps per second. Higher capacity can only
be achieved with significant hardware improvements over minimum SolarWinds requirements.
You can view SNMP traps either in the Orion Web Console or in the Trap Viewer application. The Trap
Viewer application allows you to configure trap-specific alerts, to view, filter, and search for traps.
n Configure devices to send SNMP traps to the IP address assigned to the Orion server. For more
information about proper configuration, refer to the documentation supplied by the vendor of your
devices.
n Make sure the UDP port 162 is open for IPv4 and IPv6.
n When you use SNMPv3 for polling a device and receiving traps from it, confirm that the same
authentication type (auth, noauth, or priv) is configured for both polling and traps.
You can also search trap messages using the Global Search feature. For more information, see
Search syslogs, traps and objects monitored in the Orion Web Console globally.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Trap Viewer.
2. Click View > Current Traps.
3. Click a column header to order listed traps by the selected trap characteristic.
338
4. Configure the Trap Viewer by clicking and dragging columns to order the presentation of trap
characteristics.
You can search collected trap messages and format the search results list in the Trap Viewer.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Trap Viewer.
2. Click View > Search Traps.
3. Enter search criteria, and click Search Database.
4. To group messages for easier navigation, select the type of grouping from the Grouping list.
5. To limit the number of displayed messages, enter or select a number in the Maximum number of
messages to display field.
6. To view messages that meet your search criteria as they arrive, select a number for the Auto Refresh
Every number seconds field.
Auto Refresh is only available when you are viewing current messages. The Date / Time Range
must be set to Today, Last 24 Hours, Last 2 Hours, or Last Hour.
7. To hide the search criteria pane, toggle the pane open and closed by clicking the double up arrows
in the top right of the page.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Trap Viewer.
2. Click File > Settings.
3. On the General tab, configure the Trap server settings:
a. Position the top slider to set the Maximum Number of Traps to Display in Current Traps
View.
b. If you want to Automatically Refresh the Current Traps View, select the option, and position
the middle slider to set the refresh rate.
c. Position the Retain Trap Messages For How Many Days slider to set the length of time that
traps remain in the database.
4. On the Displayed Columns tab, use the arrow keys to select and order the fields of information you
want to see in the Current Traps view.
5. If you do not need the domain name in your trap messages, select Remove Domain Name from DNS
Lookups on the Message Parsing tab.
Selecting this option can slightly reduce the size of your database.
In the Trap Viewer, you can filter trap messages, and configure actions that trigger when received trap
messages match defined rules.
With the exception of the asterisk (*) and underscore (_) wildcards, SolarWinds recommends against
using non-alphanumeric characters in filter definitions.
339
Trap rules are not applied to unmanaged nodes.
1. Click Start > All Programs > SolarWinds Orion > Syslog and SNMP Traps > Trap Viewer.
2. Click File > Settings, and click the Alerts / Filter Rules tab.
3. Click Add Rule or click Edit Rule.
4. Click the General tab, and select Enabled.
5. Select the servers from the Apply This Rule To list.
6. Apply the rule to specific messages.
n Click DNS Hostname, and enter a DNS Hostname Pattern to apply the rule to messages from
specific hosts, domains, or hostname patterns.
The DNS Hostname Pattern rule is case-sensitive.
n Click Trap Details, and enter a Trap Details Pattern to apply the rule based on the Trap Details
field.
n Click Community String, and enter the patterns in the Community String Pattern field to apply
the rule to specific community strings.
7. Click Conditions to define the what triggers the rule.
n Select object identifiers and comparison functions from the linked context menus.
n Click Browse (…) to insert conditions.
8. Click Time of Day > Enable Time of Day Checking to apply the rule during a specific period of time.
Messages received outside the specified time frame will not trigger alerts.
Enabling Time of Day checking creates more overhead for the CPU.
9. Click Trigger Threshold > Define a Trigger Threshold for this Rule to suppress alert actions until a
specified number of traps arrive that match the rule.
When Suspend Further Alert Actions For is selected, alert actions are not sent until the
specified amount of time has expired. When the time period expires, only new alerts are sent.
All alerts that are suppressed during the time period will never be sent.
Actions are processed in the order they appear, from top to bottom.
12. Click OK to save all changes and return to Trap Viewer Settings.
13. Use the arrow buttons to arrange the order in which the rules are applied.
Rules are processed in the order they appear, from top to bottom.
Trap messages are now filtered by the rules and alert actions are triggered when the rule conditions are
met.
340
What is a Trap Template?
Trap templates are used to format your trap templates. You can use SolarWinds macros or variables in the
OID Value and ValueName attributes or call values from your MIB.
n /SolarWinds/Common/Orion-Detailed-Alert.trap
n /SolarWinds/Common/Orion-Generic-Alert.trap
n /SolarWinds/Orion/ForwardSyslog.trap
The following table describes the OIDs section of the Orion Generic Alert trap template. This is the section
you modify to display the information you want in your trap messages.
Add more information by adding another OID element and incrementing the OID.
341
Integrate an Orion Platform product with ServiceNow
Integrate your Orion Platform product with ServiceNow® to automatically open new ServiceNow tickets
based on critical events defined in your Orion Platform product.
The integration with ServiceNow allows for two-way communication between your Orion Platform product
and ServiceNow. By integrating the two systems, you can:
n Automatically create incidents in ServiceNow and assign them to the correct tech or group
n Synchronize the acknowledgment of alerts and tickets in SolarWinds Orion and ServiceNow
n Update, close, and reopen tickets
n Suppress ticket storms
You can integrate one Orion Platform product with multiple ServiceNow instances.
The integration requires NPM 12.0, SAM 6.3, or any other Orion Platform product running Core version
2016.1 or later.
Before you can configure the integration details in your SolarWinds Orion product, check the prerequisites
and configure your ServiceNow instance.
n The communication between the SolarWinds server and the ServiceNow instance uses HTTPS port
443. Open this port for outbound communication.
n For minimum hardware and software requirements, see the administrator guide of your product.
n Download the ServiceNow integration application from the ServiceNow app store.
n Install the integration app and configure your ServiceNow instance for the integration.
342
Install and configure the SolarWinds Alert Integration application in ServiceNow
The SolarWinds Alert Integration application enables the communication between your SolarWinds server
and the ServiceNow instance.
After downloading the SolarWinds Alert Integration application from the ServiceNow store, deploy the
application in ServiceNow.
When the installation is complete, the caption of the Install button will change to Installed.
After the installation is complete, SolarWinds recommends that you create a ServiceNow integration user
with Web service access only.
1. Navigate to the user administration section in ServiceNow, and create a new user.
2. Provide a user ID, a password, and other required information.
3. Specify that the new user should have Web service access only.
4. Edit the newly created user, and add the x_sow_intapp.integration_user role to the role list.
After installing the integration application and creating an integration user, you can now configure the
integration with ServiceNow in your SolarWinds Orion server.
343
Configure an Orion Platform product with ServiceNow
After completing the configuration of the integration in ServiceNow, you can configure the integration to
be able to automatically create, update, and resolve alerts that were raised in your Orion Platform product
in your ServiceNow® instance.
1. In the Orion Web Console, click Settings > All Settings.
2. In the Alerts & Reports group, click ServiceNow Instances.
3. Click Add Instance.
4. Enter a name and the URL for the ServiceNow instance.
5. Enter the ServiceNow credentials:
n Username
The user name of the account that is configured for the SolarWinds integration role.
n Password
6. Test the connection to your ServiceNow instance. If the connection is not working, you receive
descriptive messages to help you solve the issue.
7. If you are accessing your ServiceNow instance through a HTTP proxy, select Use a HTTP proxy server,
and click the Configure your HTTP proxy settings link to edit the details. For more information, see
Configure web proxy settings.
8. Click Save.
344
Manage SAM technologies
The following topics detail SAM-specific technologies.
345
Work with application monitor templates
This section discusses the many operations you can perform in SolarWinds SAM regarding the use and
management of Application Monitor templates. The topics include:
346
Creating component monitors and templates
The following diagram illustrates the work flow involved in creating an application to be monitored by
SolarWinds Server & Application Monitor.
347
Requirements for component monitors and templates that use WMI
Microsoft Windows by default uses a random port between 1024 and 65535 for WMI communications. You
must create firewall exceptions to allow TCP/UDP traffic on ports 1024 - 65535 or the component monitors
and templates that use WMI will not work.
348
n Exchange 2007 Client Access Role Counters (Advanced)
n Exchange 2007 Edge Transport Role Counters (Advanced)
n Exchange 2007 Hub Transport Role Counters (Advanced)
n Exchange 2007 Mailbox Role Counters (Advanced)
n Exchange 2007 Unified Messaging Role Counters (Advanced)
n Exchange 2007-2010 Client Access Role Services and Counters (Basic)
n Exchange 2007-2010 Common Performance Counters
n Exchange 2007-2010 Edge Transport Role Service and Counters (Basic)
n Exchange 2007-2010 Hub Transport Role Service and Counters (Basic)
n Exchange 2007-2010 Unified Messaging Role Service and Counters (Basic)
n Exchange 2010 Client Access Role Counters (Advanced)
n Exchange 2010 Edge Transport Role Counters (Advanced)
n Exchange 2010 Hub Transport Role Counters (Advanced)
n Exchange 2010 OWA Form Login (PowerShell)
n Exchange 2010 Unified Messaging Role Counters (Advanced)
n Exchange 2013 Client Access Role Counters (Advanced)
n Exchange 2013 Client Access Role Services and Counters (Basic)
n Exchange Active Sync Connectivity
n Exchange Server 2000 and 2003
n File Count Script
n GoodLink Server for Microsoft Exchange
n Group Policy Object (System and Application Logs)
n Helix Universal Media Server (Windows)
n Internet Information Service (IIS) 6
n JD Edwards EnterpriseOne Server Manager (Windows)
n Kaspersky Security Center Antivirus
n Kiwi Syslog Server
n Log Parser (PowerShell)
n Microsoft DirectAccess 2008 R2
n Microsoft DirectAccess 2012
n Microsoft DirectAccess 2012 R2
n Microsoft DirectAccess 2012-2012 R2 (Health with PowerShell)
n Microsoft Dynamics CRM 4.0 Events
n Microsoft Dynamics CRM 4.0 Statistics
n Microsoft Dynamics CRM 2011 Events
n Microsoft Dynamics CRM 2011 Statistics
n Microsoft Forefront Endpoint Protection 2010 Client
n Microsoft Forefront Endpoint Protection 2010 Server
349
n Microsoft Forefront Threat Management Gateway 2010
n Microsoft IIS SMTP Server
n Microsoft Lync Server 2013 (Edge Role)
n Microsoft Lync Server 2013 (Front-End Role)
n Microsoft Lync Server 2013 (Mediation Role)
n Microsoft Lync Server (Edge Role)
n Microsoft Lync Server (Front-End Role)
n Microsoft Lync Server (Mediation Role)
n Microsoft Message Queuing Events
n Microsoft Message Queuing Performance
n Microsoft Network Policy Server Events
n Microsoft Network Policy Server RADIUS Proxy
n Microsoft Network Policy Server RADIUS Server
n Microsoft Routing and Remote Access 2008-2012 R2
n Microsoft Routing and Remote Access 2008-2012 R2 (Events)
n Microsoft System Center Configuration Manager 2012
n Microsoft System Center Operations Manager 2012 (Agent)
n Microsoft System Center Operations Manager 2012 (Management Server)
n Microsoft Windows Internet Name Service (WINS) Events
n Microsoft Windows Internet Name Service (WINS) Statistic
n Microsoft Windows Server 2003 Failover Cluster
n Microsoft Windows Server 2008 Failover Cluster
n Microsoft Windows Server 2008 R2-2012 R2 Failover Cluster (Advanced)
n Microsoft Windows Server 2012 Failover Cluster
n Microsoft Windows Server 2012-2012 R2 Failover Cluster
n MongoDB (Windows)
n Novell GroupWise Message Transfer Agent (Windows)
n Novell GroupWise Post Office Agent (Windows)
n Office 365 User Statistics with PowerShell
n Orion Server
n Remote Desktop Services Licensing
n Server Clock Drift (PowerShell)
n SharePoint Server 2010
n SharePoint Server 2013
n SharePoint Server (MOSS) 2007
n SharePoint Services (WSS) 3.0
n SolarWinds Failover Engine
n SolarWinds NetFlow Traffic Analyzer
350
n SolarWinds Web Performance Monitor (WPM) Player
n SQL Server 2005 Analysis Services
n SQL Server 2008 Analysis Services
n SQL Server 2008 R2 Reporting Services
n SQL Server 2008 Reporting Services
n SQL Server 2008-2012 Reporting Services (Events)
n SQL Server 2012 Analysis Services
n SQL Server 2012 Reporting Services
n Squid (Windows)
n Streaming Media Services 2008
n Symantec Backup Exec Remote Agent
n Symantec Backup Exec Server
n Symantec Endpoint Protection Client
n Symantec Endpoint Protection Server
n Symantec NetBackup Client
n Symantec NetBackup Server
n Terminal Licensing Server
n Trend Micro OfficeScan Client
n Trend Micro OfficeScan Server
n Trend Micro Server Protect (Windows)
n UniData Database (Windows)
n Veeam Backup and Replication Server
n VMware vCenter Server 5.5
n Websense Web Security
n Windows 2003-2008 FTP Service
n Windows 2008 R2 - 2012 FTP Service
n Windows DHCP Server
n Windows DNS Server
n Windows Network Load Balancing
n Windows Print Services
n Windows Remote Desktop Services (Session Host Role)
n Windows Server 2003 Domain Controller Security
n Windows Server 2003-2012 Services and Counters
n Windows Server 2008-2012 Domain Controller Security
n Windows Update Monitoring
351
Create and manage templates
You can create a new template or manage existing templates by using the commands on the SAM Settings
page.
You may need to log in with an administrator account to perform these actions.
1. On the Web Console, click Settings > All Settings > SAM Settings > Scan Nodes for Applications.
2. Follow the instructions in the Wizard .
Create templates
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates > Create New
Template.
2. Name the template, add application monitors as desired, and then click Submit.
The following procedure creates a SolarWinds SAM Application Monitor template that monitors a locally
installed SQL Server instance. The template is simplified by using the Windows Service component
monitors, a TCP port monitor for your SQL Server, and an HTTP monitor for the local Web Console.
n TCP port component monitor to monitor port 1433, the port through which SolarWinds
communicates with the SQL Server.
n Service component monitors for the following windows services:
l SolarWinds Alerting Engine
l SolarWinds Network Performance Monitor
l SolarWinds Job Engine
l SolarWinds Job Scheduler
l SolarWinds Module Engine
l SolarWinds Syslog Service
l SolarWinds Trap Service
HTTP component monitor to monitor port 80, the port through which you access the SolarWinds Web
Console.
1. On the Web Console, click Settings > All Settings > SAM Settings > Create New Template.
2. Name your template, and then click Add Component Monitor, expand the Network Protocol
Component Monitors list, and then check TCP Port Monitor.
3. Click Submit.
352
4. Click Rename and then name the TCP port monitor, and then click OK.
5. Ensure the Port Number field corresponds to the port used to communicate with the SolarWinds SQL
Server instance. By default, this is port 1433.
6. Click Add Component Monitor, then expand the Process and Service Component Monitors, and then
check Windows Service Monitor and click Submit.
7. Click Rename, name the SolarWinds Alerting Engine monitor, then click OK.
8. Enter or select the credential set to use when accessing the Windows service information.
9. Enter the name of the SolarWinds Alerting Engine service in the Net Service Name field.
Repeat the steps as needed for the following SolarWinds Windows services
11. Click Add Component Monitor then expand the User Experience Component Monitors list, and then
check HTTP Monitor.
12. Click Rename, name the HTTP port monitor, then click OK.
13. Ensure the Port Number field corresponds to the port you use for the SolarWinds Web Console port,
then click Submit.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the template(s) to assign, and then click Assign to Node.
3. Specify the node(s) to monitor and then click Next.
4. Enter or select the appropriate credentials.
5. Click Assign Application Monitors.
Edit templates
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check an application template and click Edit.
3. Specify the values for the Polling Frequency and Polling Timeout fields.
Note: Setting a polling frequency below 30 seconds can result in erratic monitor behavior.
4. Click Add Component Monitor, and then expand the component groups and all the component
monitors to add.
5. Click Submit.
6. Configure the component monitor settings, and then click Submit.
353
Copy templates
After successfully creating a complicated template, instead of having to recreate it over for a similar
application, consider copying the template. This will allow you to only modify those properties that differ.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check an application template and then click Copy.
Export templates
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check an application template and then click Import/Export > Export as File, then click Save.
Import templates
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Click Import/Export > Import > Browse, then select the template file, then click Open.
3. Click Submit.
Note: If you import a template with the same name as one of your existing templates, the name of
the imported template is modified by appending (n) to the name, where n is an integer.
Delete templates
n Deleting a template also deletes all of its assigned applications, both modified and unmodified.
n To speed user interface interaction, data is not immediately removed from the database, but
systematically updated every few minutes in the background.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the template(s) to delete and then click Delete.
3. Confirm deletion by clicking Yes.
Tag templates
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the templates to tag, then click Tags > Add existing tag(s) > Submit.
Remove tags
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the templates to tag, and then click Tags > Remove tag(s) > Submit.
354
Multi-Edit templates
Multiple component monitors within a template can be edited simultaneously. As indicated by the toolbar,
multiple monitors can be selected to: Assign Credentials, Test, Set Test Node, Disable, and Delete. The
monitors selected do not to be of the same type when performing a multiple monitor edit. When
performing a multiple monitor edit, the correct buttons will become enabled and/or disabled based on
your selection.
The Multi-Edit button allows you to change the options of two or more monitors of the same type,
simultaneously. To enable the Multi-Edit button, two or more monitors of the same type must be selected.
Once multiple monitors of the same type are selected, the Multi-Edit button becomes enabled. In the
illustration below, three monitors (Services) are checked and the Multi-Edit button is enabled:
Different types of monitors will have different options available for editing.
355
Create a new template
SolarWinds SAM allows you to create new templates by bundling component monitors together. There are
two ways of creating a template from scratch. The traditional method allows you to create any kind of
template. The browsing method only creates templates monitoring services, processes, and performance
counters.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings.
2. Under Application Monitor Templates, click Manage Templates.
3. Locate your template and click Assign to Node.
4. Select the Windows nodes you want to monitor for the operating system on the left pane, click the
green arrow to move it to the right pane, and click Next.
5. Choose the credentials, click Assign Application Monitors, and click Done.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Create a new template.
2. Name the template and specify values for Polling Frequency and Polling Timeout.
Note: Setting a polling frequency below 30 seconds can result in erratic monitor behavior.
3. Click Add Component Monitor then expand the component groups and check all the component
monitors to add.
Note: You can select multiple component monitors of the same type to be added by entering a
number in the field next to the check box for the component monitor and then checking the check
box.
4. Click Submit then configure the component monitor settings, and then click Submit.
356
Work with Multi-Edit templates
Multiple component monitors within a template can be edited simultaneously. The monitors selected do
not to be of the same type when performing a multiple monitor edit. When performing a multiple monitor
edit, the correct buttons become enabled or disabled based on your selection.
Once the Multi-Edit button is pressed, a pop-up window is dispalyed with editing options specific to the
type of monitor selected. For example, the Fetching Method for the three Services selected can be changed
from RPC to WMI.
Order components
When editing a template, the green arrows to the right of each component monitor, highlighted below, lets
you to change the order of each monitor. This new order is respected only on the All Applications resource
and the Application Details resource.
You may need to log in with an administrator account to perform these actions.
Copy a template
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the application template you want to copy, and then click Copy.
Delete a template
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the application template you want to copy, and then click Delete.
3. Confirm by clicking Yes.
Tag a template
Tags are descriptive labels that help you classify and sort your application templates on the Manage
Application Monitor Templates page. The application templates included in SolarWinds SAM have already
been tagged with several descriptive labels you can modify as you see fit.
Add tags
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the templates you want to tag, then click Tags.
3. Click Add existing tag(s) or select the tags from the list.
4. Type the tags, separating multiple tag entries with commas, then click Submit.
357
Remove tags
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the templates you want to tag, then click Tags > Remove Tags.
3. Select the tags from the list, then click Submit.
358
Manually assign application monitors
The quickest way to assign Application Monitors to nodes is through the Add New Application Monitors
Wizard, but you can also assign them through the Manage Templates page.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manually Assign Application
Monitors.
2. Select the Application Monitor template to apply, and then click Next.
3. Select the server nodes to which you want to apply the Application Monitor template, and then click
Next.
4. Select existing credentials or create new credentials, then click Assign Application Monitors.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select the tag by which to filter the templates, then select the template you want to assign.
3. Click Assign to Node, then select the server nodes to which you want to apply the Application
Monitor template, and then click Next.
4. Select existing credentials or create new credentials, then click Assign Application Monitors.
5. Review the information for the assigned Application Monitor and then click Done.
359
Manage component monitors within templates
You can manage individual component monitors that have been assigned to collect data on a single object
such as a process, port, or performance counter.
You may need to log in with an administrator account to perform these actions.
1. From the web console, click Settings > All Settings > SAM Settings > Create New Template.
2. Name the template then click the Add Component Monitors drop down menu.
3. Select a method for adding component monitors.
4. The browsing method opens the Component Monitor Wizard. Add component monitors as needed.
360
3. Select the component monitors to assign to a node, and then click Assign to Node.
4. Name the application and specify the polling frequency and polling timeout period.
5. Click Next, and select the nodes that you want to assign the Application Monitor. Click Next.
6. Enter or select the appropriate credentials, and click Assign Application Monitors.
361
Work with templates and groups
Following are frequently asked questions and answers concerning templates and groups.
Question Answer
If I assign a template to a group and then I Nothing will happen since the application has already
add a node that already has the same been created.
template assigned to it, what happens?
If I assign a template to a group that is OS Yes. The logic is that members of the group get assigned
specific, such as the Microsoft Windows to the template.
Server 2003 Failover Cluster template, and
then I add a Windows Server 2012 R2 server
to the group, will the 2003 specific temple be
added to the 2012 R2 node?
What happens if I add a Linux template to a The application will be created but the status will be
Windows group? reported as Unknown.
If I delete a group that has applications This depends on whether or not you unchecked the
assigned to it, what happens to the templates default behavior of the group found in Advanced
that were assigned via the group? Do they get section. By default, the answer is yes. All members will
removed from those nodes? be removed and therefore all of the applications on
them will be removed.
If I have a node in two different groups that No. If you remove a node from the first template, the
share application templates, will the node get application is not removed and it is marked as assigned
362
assigned to copies of the same template? to the second node.
Can I assign credentials to a node and have There is no credential associated with a group; however,
all of the templates assigned to that group you can select Inherit Credentials from Node when using
use that credential? WMI or an agent. The new application created from the
template will use credentials from the node that is
assigned to.
363
Assign an application template to a group
Assigning an application template to a group is more efficient than applying the template to individual
nodes one at a time. Before you begin, a group must be created. To create a group, see Create groups.
Nested groups are not supported. AppInsight applications cannot be assigned to groups.
Application assignment to a group happens in the background and can take some time to be
created depending on the size of the application.
1. On the web console, click Settings > All Settings > SAM Settings > Manage Templates > Application
Monitor Templates.
2. Select an application template and then click, Assign to Group.
364
3. Select a group from the Available Groups column, click the green arrow, and then click Next.
Note: By default, the template is assigned to those nodes in the group that are running a server
operating system. This can be changed in the Advanced section at the bottom of the page. When a
node is removed from a group, the application is deleted from the node by default. You can override
this by selecting No under the Advanced section.
To view the applications within a group, in the web console, click My Dashboards > SAM Summary and
then click a group in the Application Templates Assigned to Group resource.
365
You can create dynamic groups and assign templates to these groups. For example, a dynamic
group can be created for all Windows computers and the Windows Update template can be applied
to the nodes of the group dynamically.
Got questions? See the FAQs on this feature at Work with templates and groups.
366
Unassign application monitors from a group
1. On the web console, click Settings > All Settings > SAM Settings > Manage Templates > Application
Monitor Templates.
2. Select the application monitor you want to unassign from the group, and then click the link in the
Assigned To column.
3. On the Template Assignments page, click the Group tab and then click Unassign > Yes, Unassign.
367
Manage assigned application monitors
You can manage Assigned Application Monitors by referring to the following sections:
368
Edit an assigned application monitor
You can override the template inheritance relationship by editing the components of an assigned
Application Monitor. Any modifications you make to an application’s components or component properties
are independent from the template. New components that you add to the application are not governed by
the original template used to create the application. Modified component properties override the original
template settings.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Click the group containing the application you want to edit.
3. Check the application you want to edit, and then click Edit Properties.
4. Click Override Template for each polling setting and specify the new value.
5. Expand the component you want to modify, and then click Override Template and specify new
values.
6. To add components unique to this specific application, click Add Component Monitor then
click Submit to apply your changes..
You can select multiple component monitors of the same type to be added by entering a number in
the field next to the check box for the component monitor and then checking the check box.
369
Unmanage assigned application monitors
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Click the group containing the application to unmanage, select the applications to unmanage, and
then click Unmanage.
3. Specify the date/time to begin and end the period when the application is unmanaged, then click
OK.
370
Remanage assigned application monitors
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Click the group containing the application to remanage.
3. Check the application(s) to remanage, and then click Remanage.
371
Delete assigned application monitors
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Application Monitors.
2. Click the group containing the application to delete.
3. Check the application(s) to delete, and then click Delete, then click Yes to confirm.
372
Use the JMX component monitor wizard
Creating a standard template for this monitor is not practical because of the amount of variables in any
one specific environment. However, adding this monitor to your environment has been made simple with
the use of a wizard driven interface.
Only values that return numerical data can be monitored. String data is not supported at this time.
Non-numerical data is shown without a check box.
1. On the Web Console, click Settings > All Settings > SAM Settings > Component Monitor Wizard.
2. Select JMX Monitor from the drop down list and then click Next.
3. For Server IP Address, click Browse, then select the node you want to monitor.
4. Add the Port number, Protocol type, URL path, and Credentials for the remaining fields.
5. Click Next. The following MBean selection screen appears:
6. Expand the folders by clicking the arrows (or [+]) to expand the tree view folder structure. From here
you can drill down to select the attributes you want by checking them.
7. Click Next.
373
Configure the SOAP monitor
Load WSDL Files
The SOAP monitor within SAM currently supports the WSDL schema, which must be exposed on a URL.
Once the WSDL file is successfully loaded, the file is parsed automatically and the fields, highlighted
below, populates. Once the WSDL file has been successfully loaded, you can specify values for the
available arguments. There are two types of arguments, simple, and complex.
A simple argument is one where you can define the value directly. A complex argument (e.g. structures,
classes, list, and so on) must be user-defined in the XML format. It is recommended that complex
arguments be used only by experienced users.
The Advanced Settings are read-only and displays additional information. Because the SOAP
envelope is based on the WSDL schema, the Advanced Settings values should not be changed.
The SOAP XML field contains the SOAP envelope which is generated by the WSDL and dynamically
changes as you make changes to the SOAP settings. In this field you can check what is to be sent to the
web service.
Important: If changes are made to any of the base SOAP settings, the content of the SOAP XML is
re-generated and your changes become lost.
374
Manually Enter XML
The following is an example of a Complex argument and would be placed in the Parameters field.
SAM automatically takes the code and place it where it belongs in the envelope:
<tempPhoneNumber
xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"
xsi:type="ns2:Array" ns2:arrayType="ns1:TemporaryPhoneNumber[3]">
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37060</startDate>
375
<endDate xsi:type="xsd:int">37064</endDate>
<phoneNumber xsi:type="xsd:string">+1-212-5551234</phoneNumber>
</item>
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37074</startDate>
<endDate xsi:type="xsd:int">37078</endDate>
<phoneNumber xsi:type="xsd:string">+1-212-5554321</phoneNumber>
</item>
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37088</startDate>
<endDate xsi:type="xsd:int">37092</endDate>
<phoneNumber xsi:type="xsd:string">+1-212-5557890</phoneNumber>
</item>
</tempPhoneNumber>
376
Script custom component monitors
Ten output pairs can be returned when using script monitors. A usage example using the PowerShell
script monitor might go like this:
Imagine you have an Exchange PowerShell script. With multiple values returned, you can get a mail traffic
report broken down by day, hour, message size, and number of recipients.
If you exceed the maximum number of allowed output pairs of ten, the remainder above the tenth
output pair is ignored.
The following sections provide information and guidance to help you create some of the more complicated
types of component monitors.
n Adapt an existing Perl script to a Linux/Unix Script component monitor in a new template
n Field Descriptions
n Return Codes
n What needs to be monitored
For general information about the settings for each component monitor, click the More Information help
link in the SolarWinds SAM component monitor description.
SolarWinds fully supports scripts written and provided by the company; however, we do not provide
customer support for custom scripts written by outside sources. SolarWinds does provide sample
scripts that we do support located at: C:\Program Files\SolarWinds\Orion\APM\Sample-
Script Monitors.
n Conversion value
n Available data transformations
377
Create a Linux or Unix script monitor
Linux and Unix Script component monitors allow you to execute a command line script that can return
statistical data. When collecting information for this monitor, SAM runs the script with the credentials
defined with the Credential Library.
A maximum of 10 output pairs can be monitored per script monitor. More than 10 defined pairs
results in a failure of the monitor.
Note: {SCRIPT} is replaced by the actual file name of the script after it’s deployed to the target
node. (A temporary file is created in temp directory for the script).
7. Click Get Script Output. SAM then tests the script by executing it and parse its output, then return
the values.
8. Click Save, then specify the critical and warning thresholds and click Submit.
Here is a sample Perl script using the Linux/Unix component monitor returning multiple output pairs, in
this case, two:
The code in red shows where the output pairs are defined.
#!/usr/bin/perl
if (@ARGV[0] =~ /\bhelp\b/)
{
print "MemoryUsage.pl SNMPver community hostname\n";
print "SNMPver - version of SNMP protocol\n";
print "community - community name of SNMP protocol\n";
print "hostname - Target host\n";
378
exit 1;
}
# Get hostname and trim newline
$localhost = `hostname`;
$localhost =~ s/\s*$//g;
$hostname = shift ||
$localhost;$community = shift || "public";
$version = shift || "v1";
$results = "";
$MIB_TotalMemory = "UCD-SNMP-MIB::memTotalReal.0";
#$MIB_TotalMemory = "UCD-SNMP-MIB::memTotalReal.0";
$outres = "snmpget -$version -c $community $hostname $MIB_TotalMemory |";
open(OUTMEM,$outres) || die "Unable read pipe\n";
while ($line = <OUTMEM>) {
if ($line =~ /\bINTEGER\b/) {
$indval = index($line,"=");
$indval=inde($line,":",$indval);
$val = substr($line,$indval+1,length($line) - $indval);
$val =~ s/[a-zA-Z\/\n ]//
print "Message.1: Available memory at host \"$hostname\": $val in
kB\n";
print "Statistic.1: $val\n";
print "Message.2: Again, the available memory at host \"$hostname\":
$val in kB\n";
print "Statistic.2: $val \n";
exit 0;
}
}
print "Statistic: 0\n";
exit 1;
379
Linux/Unix scripts
Linux/Unix scripts are uploaded by SSH and then run on the target node using the string from the
Command Line field.
You can use the following variable in the command line field:
${SCRIPT}
You can use the following variables in the script body field:
${IP}
${USER}
${PASSWORD}
Example Scripts
There are several sample scripts installed with SolarWinds SAM you can use to create Linux/Unix script
component monitors. These sample scripts are installed on your SolarWinds SAM server, in the folder:
C:\Program Files\SolarWinds\Orion\APM\SampleScriptMonitors\LinuxScripts
Scripts must report their status by exiting with the appropriate exit code:
0 Up
1 Down
2 Warning
3 Critical
For example, if you want to inform SolarWinds SAM that a Script reports Up status, you would exit the
script using code similar to the following, where 0 reports Up: Wscript.quit(0)
Scripts report additional details by sending text to the script’s standard output.
380
SAM supports multiple values returned by a script using the following format.
Statistic Yes A numeric value used to determine how the monitor compares to its set
thresholds. This must be an integer value, (negative numbers are supported).
Statistic.Name1: 123Statistic.Name2: 456
There is a limit of ten Statistic and Message pairs for the script. These can be placed anywhere in the
script output. The Statistic and Message names you give must contain valid letters and/or numbers.
Sample output:
# Script comment: This shows two pairs. Ten pairs are possible.
Statistic.CPU: 31.08
Statistic.RAM: 1234.56
381
Create a Windows Script monitor
This component monitor runs a Windows script on the SolarWinds SAM server and then processes the
script's exit code and text output. This monitor has the ability to return up to ten pairs, i.e.: 10 statistic
values + 10 [optional] messages. This is best used in conjunction with theMultiple Statistic Chart.
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they will simply be ignored.
Statistic
The statistic for this component monitor is the value returned by the script.
At least one message and statistic is required. The statistic must be a valid integer and be able
to be converted to double, otherwise it is handled as Not as Number (NaN)There is no
maximum length for the message; however, only alphanumeric characters and the underscore
are allowed.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
Select a Windows credential that is both a user who can log on to the SolarWinds SAM server, and
has sufficient rights on the target node (which may be the SAM server itself, depending upon your
application) to do whatever the script needs to do. For example, if the script does something with
WMI, the credentials also need WMI rights on the target node. If the credential you need is not
already present in the credentials list, use the Quick Credentials section to add a new credential.
Script Engine
This field allows you to specify the scripting language to be used. The default value is vbscript. Below
is a list of scripting engines that the Windows Script Host supports:
382
Name File Extensions Availability
VBscript runs locally on the SAM server only. PowerShell uses WINRM that runs over TCP ports 5985
and 5986. All Linux, Unix, and Nagios script monitors use SSH over TCP Port 22.
Roll-Up
This option allows you to choose how you would like the monitor to report the returned results based
on the output provided by the script. With the ability to have multiple values returned, selecting how
your scripts report back to you offers more flexibility. The default selection is “Show worst status."
Script
This field allows you to enter the script you want to run on the target node. To enter your script, click
the Edit button that reveals the script editing window.
Script Arguments
This field is in the script editing window and allows you to specify arguments to pass to the script.
You may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced respectively
by the IP address of the target node, the credential user name, and the credential password.
Body
This field is in the script editing window and allows you to enter your script via typing or pasting.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
383
Creating a Windows Script Monitor
You can create a Windows Script monitor to have SolarWinds SAM run a script using Windows Script Host.
Windows Script Host comes with VBScript and Jscript, but can be extended with other scripting languages.
Scripts run on the SolarWinds SAM server and use the credentials you specify. The script must both return
an exit code and output a text string containing a statistic value conforming to the specifications described
later in this section.
Format the Statistic value to use the same decimal separator as the SolarWinds SAM server. The
SolarWinds SAM server uses the decimal separator set by its Microsoft Windows regional settings.
You may need to log in with an administrator account to perform this action.
Specify script arguments in the Script Arguments field if needed. You can use the following variables as
script arguments:
${IP}
${USER}
This is replaced with the user name from the credential set.
${PASSWORD}
Scripts must report their status by exiting with the appropriate exit code:
384
0 Up
1 Down
2 Warning
3 Critical
For example, if you want to inform SolarWinds SAM that a VBScript reports Up status, you would exit the
script using code similar to the following, where 0 reports Up:
Wscript.quit(0)
Scripts report additional details by sending text to the script’s standard output. SAM supports multiple
values returned by a script using the following format.
Statistic Yes A numeric value used to determine how the monitor compares to its set
thresholds. This must be an integer value, (negative numbers are supported).
Statistic.Name1: 123Statistic.Name2: 456
There is a limit of ten Statistic and Message pairs for the script. These can be placed anywhere in the
script output. The Statistic and Message names you give must contain valid letters and/or numbers.
Sample output
# Script comment: This shows two pairs. Ten pairs are possible.
385
Example Scripts
Below is a sample vbscript that returns two values; the total number of files in a folder, and twice the total
number of files in the same folder. The code that represents these two values are bold, To use this script,
copy and paste the following code into the Script Body field. In the Scripts Arguments field, type in
C:\Windows, or any other folder you want to monitor.
Option Explicit
On Error Resume Next
Dim lstArgs, path, fso, objDir, objFiles, objFiles2
Set lstArgs = WScript.Arguments
If lstArgs.Count = 1 Then
path = Trim( lstArgs( 0 ))
Else
WScript.Echo "Message: Usage: wscript.exe filelist.vbs [pathToFiles]" &vbCRLF &"
[pathToFiles] Local or UNC Path"
WScript.Echo "Statistic: 0"
WScript.Echo "Message: Usage: wscript.exe filelist.vbs [pathToFiles]" &vbCRLF &"
[pathToFiles] Local or UNC Path"
WScript.Echo "Statistic: 0"
WScript.Quit( 1 )
End If
Set fso = Wscript.CreateObject( "Scripting.FileSystemObject" )
If fso.FolderExists( path ) Then
Set objDir = fso.GetFolder( path )
If( IsEmpty( objDir ) = True ) Then
WScript.Echo "Message: Object Not Initialized"
WScript.Echo "Statistic: 0" WScript.Quit( 1 )
End If
Set objFiles = objDir.Files
If( IsEmpty( objFiles ) = true) Then
WScript.Echo "Message: Object Not Initialized"
WScript.Echo "Statistic: 0"
WScript.Quit( 1 )
End If
WScript.Echo "Message.Total: " & CInt( objFiles.Count ) & " files in this folder."
WScript.Echo "Statistic.Total: " & CInt( objFiles.Count )
386
WScript.Echo "Message.Twice: " & CInt( objFiles.Count*2 ) & " = twice the number
of files in this folder."
WScript.Echo "Statistic.Twice: " & CInt( objFiles.Count*2 )
WScript.Quit( 0 )
Else
WScript.Echo( "Message: Folder Not Found" )
WScript.Echo "Statistic: 0"
WScript.Quit( 1 )
End If
There are several examples of Windows Script component monitors included in templates. These include:
File Count, File Modified, LDAP Connection Monitor, Run 3rd Party Application, and Windows Event Log
Count.
Sample scripts are installed on your SolarWinds SAM server, in the folder:
C:\Program Files\SolarWinds\Orion\APM\SampleScriptMonitors\WindowsScripts
387
Create a Nagios script monitor
This component uses SSH to upload a Nagios script to a Linux or Unix server, runs the Nagios script on the
server and then processes the script's exit code and text output. This monitor has the ability to return
multiple values.
A maximum of 10 output pairs can be monitored per script monitor. More than 10 defined pairs
results in a failure of the monitor.
Return Codes
Nagios determines the status of a host or service by evaluating the return code. The following table shows
a list of valid return codes, along with their corresponding service or host states.
0 OK Up
1 Warning Up or Down/Unreachable†
2 Critical Down/Unreachable
3 Unknown Down/Unreachable
___________________
†If the Use Aggressive Host Checking option is enabled, return codes of 1 will result in a host state of Down, otherwise
Nagios scripts must exit with a valid return code and a line of text output. The exit code determines the
status of the component. If the exit code is 0 (OK), the component status may be further modified by
thresholds from the optional statistics. To return up to ten optional statistics, separate the statistics from
the status message with the pipe (|) symbol using the following syntax:
statusMessage [|'statisticName'=value]
Below is an example of valid output with a status message and two statistics:
Statistic
The statistic for this component monitor is the value returned by the script. For more information, see
http://nagios.sourceforge.net/docs/3_0/pluginapi.html.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
388
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
Authentication Type
Select a credential that can access the Linux or Unix server over SSH and that has sufficient rights to run
scripts. If the credential you need is not already present in the credentials list, use the Quick Credentials
section to add a new credential. Certificates are also supported.
Port Number
This field allows you to specify the port number used for the SSH connection. The default value is 22.
This field allows you to specify the working directory of the script process.
Check Type
Status Roll-Up
This option allows you to choose how you would like the monitor to report based on the output
provided by the script. The default selection is “Show worst status."
Command Line
This field is in the script editing window and allows you to specify the shell command run after the
SSH connection is established. The default command line value perl ${SCRIPT} arg1 arg2 attempts to
run in a Perl interpreter the script defined in the Body field using the parameters arg1 arg2.
The length of the Command Line field is limited to 266 characters for Solaris systems, minus the
length of the ${SCRIPT} variable after being resolved to a file name such as the following: APM_
937467589.pl. Since the length of the file name will typically be around 16 characters, this means
that the actual user Command Line input cannot be longer than 266 - 16, or 250 characters (not
including the length of the 9 characters for the “${SCRIPT}" variable itself). If you need to pass a
longer command line to the target node, you can create a shell script on the target node (for
example: myscript.sh) that contains the long command line and place the call to this script in the
Command Line field, for example: /opt/sw/myscript.sh
Body
This field is in the script editing window and allows you to enter your script via typing or pasting.
389
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
390
Create a Windows PowerShell monitor
With this, you can create a monitor that runs a Windows PowerShell script to monitor specific performance
information for troubleshooting a Windows process that may be having issues.
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they will simply be ignored. You may need to log in with an administrator
account to perform this action.
The process you want to monitor is lsass.exe, which enforces security on the system for users who are
logging on, changing passwords, and so forth. In particular, you want to monitor the average number of
read operations performed to check for spikes.
You decide to use the Windows PowerShell monitor to run a PowerShell script that uses the Get-WmiObject
call to measure the average ReadOperationCount for the lsass.exe process and monitor its value.
1. On the Web Console, click Settings > All Settings > SAM Settings > Create a New Template
2. Name the template, for example, Lsass.exe PowerShell Monitor.
3. Click Add Component Monitor, then expand the Custom Component Monitors group, and then
select WindowsPowerShell Monitor and click Add.
4. Select the Credential for Monitoring with appropriate permissions to run the script on the
SolarWinds SAM server, and that also has appropriate permissions to do whatever else the script
requires (in this case, to get the average number of read operations performed on the target node).
5. Select the Execution Mode to use:
n Local Host can run scripts only locally, that is, on the SolarWinds SAM server.
n Remote Host can execute scripts remotely (on the remote target node to which the Windows
PowerShell monitor is assigned) using the Windows Remote Management (WRM) system
component. WRM should be configured separately to get it working with the Windows
PowerShell monitor.
6. Copy the following PowerShell script, which uses the Get-WmiObject call to measure the average
ReadOperationCount for the lsass.exe process, into the Script Body field:
a. Reads the average ReadOperationCount information for the process lsass.exe from the
computer whose IP address is specified by the variable ${IP} using the credential specified by
the variable ${CREDENTIAL} .
391
Note: The user name from the Credential for Monitoring that is specified is stored
automatically in the ${CREDENTIAL} variable by the monitor. Therefore the ${CREDENTIAL}
variable should not be placed in the Script Arguments field, since it is set automatically. When
the script is run by PowerShell, since no password has been provided, it prompts for a password
and the password from the Credential for Monitoring that is specified is provided automatically
by the Windows Powershell monitor.
8. Select Run the script under specified account to enable impersonation with the component's
credentials. (This works only in local script execution mode.)
9. Select Count Statistic as Difference to change the statistic to be the difference in query values
between polling cycles.
10. Change the Statistic Warning Threshold to, greater than 800.
11. Change the Statistic Critical Threshold to, greater than 1000.
12. Click Set test node. Browse the tree view, select the desired target node for the PowerShell script,
and then click Select.
13. Click Test, and then click Submit.
14. Click All in the Select tag to filter by list, and then locate the Lsass.exe PowerShell Monitor.
15. Select Lsass.exe PowerShell Monitor and then click Assign to Node.
16. Expand the tree view and select the target node, and then click Next.
17. Select Inherit credentials from template, and then click Test to confirm the credentials and
component monitor against the test node.
18. Click Assign Application Monitors and then click Done.
Make sure that the RPC server is available and that the Windows PowerShell execution policy is not set to
Restricted (the default setting). You can check the execution policy by entering the following command at
the PowerShell command prompt:
Get-ExecutionPolicy
392
If you are having trouble using the Windows PowerShell Monitor, see the following KB article for some
useful tips:
https://support.solarwinds.com/success_center/Server_%26_Application_Monitor_(SAM)/Problems_using_
the_Orion_APM_Windows_PowerShell_Monitor
393
Application Monitor Thresholds
Thresholds are markers that indicate certain levels have been reached. Many component monitors used in
SAM applications have thresholds that can be adjusted and set.
Once set, thresholds can act as trigger points. For example, if you are monitoring CPU usage, a Critical
threshold set at 90% would be typical. You can use this threshold as a trigger to send an email alert to
inform you of the Critical status once that threshold has been breached.
Normally, an administrator would need to monitor applications for several weeks in order to collect
enough data to be used as a baseline. Once a baseline has been established, the administrator can make
an educated guess how to set Warning and Critical thresholds for the component monitors. Note, if
thresholds are set too low, the administrator would be getting alerts all the time. If set too high, problems
can occur without the administrator's knowledge.
Baseline data, as well as Warning and Critical thresholds for application monitors, can be gathered and
calculated automatically. The option to enter thresholds manually remains available.
394
Inheriting Thresholds
Thresholds can be adjusted at the template level or on the individual component monitor level of an
application.
395
Multi-Value scripts and thresholds
The format for using the threshold macros with multi-value scripts is as follows:
n ${Threshold.Warning.DisplayName}
n ${Threshold.Critical.DisplayName}
396
Apply baseline thresholds at the template level
Applying and editing thresholds at the template level affect all applications that are based on that
template. Thresholds can be used based on calculated baseline data or you can create your own
thresholds based on your needs.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select a template and click Edit from the toolbar.
3. Select a component monitor, click [+] to expand the monitor details.
4. Select Use thresholds calculated from baseline data:
Once this box is checked, the Warning and Critical fields automatically populate with the macro,
${USE_BASELINE}. This macro can be used when configuring alerts.
5. Select the options for sustained thresholds, and then click Submit.
You can edit multiple component monitors and their thresholds if the monitors are the same type
and thresholds are available. Multi Edit only become available when the selected component
monitors are the same type, as shown. After you click Multi Edit, select Statistic Threshold > Use
thresholds calculated from baseline data. Edit thresholds, click Save > Submit.
397
By default, I/O thresholds of Windows Service Monitors are not set.
398
Apply baseline thresholds at the application level
You may need to log in with an administrator account to perform this action.
c. When applied, the values change and a blue icon appears indicating that baseline thresholds
are being used.
5. If selecting more than one component monitor, use the check boxes to select the monitors you want
to edit, and then click Multi-Edit.
a. Click Multi-Edit.
Note: Multi-Edit only becomes available when the selected component monitors are of the
same type.
b. Check the Statistic Threshold check box on the pop-up window, then check the Use
thresholds calculated from baseline data.
Note: Once the second box is checked, the Warning and Critical fields automatically populate
with the macro, ${USE_BASELINE}.
399
6. Click Save, then click Submit.
400
Adjust threshold settings and apply baseline data
In general, baseline data is calculated on demand; however, seven days of data is the recommended
minimum amount of data needed for baseline calculations to be considered accurate.
Baseline data for macros, such as ${USE_BASELINE}, are automatically calculated during nightly
database maintenance.
Once thresholds are calculated and applied to component monitors, the thresholds remain static until
manually re-applied. This is not a moving baseline that is calculated nightly based on the last seven days
of data. A moving baseline would mask data spikes and other anomalies that need to be highlighted.
Thresholds set manually may yield more desirable results if you are familiar with the nuances of
your environment.
1. On the Web Console, click Settings > All Settings > SAM Settings > Data & Database Settings.
The value for the Baseline Data Collection Duration field cannot exceed the value defined for the
Detail Statistics Retention field (located at the top of the Data & Database Settings section).
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates .
2. Check a template and click Edit from the toolbar.
401
3. If selecting only one component monitor, click [+] to expand the monitor details.
a. Click Use Latest Baseline Thresholds, as shown:
Note: Once this box is checked, the Warning and Critical fields automatically populate with
the macro, ${USE_BASELINE}.
b. Select the options for sustained thresholds, if desired:
4. If selecting more than one component monitor, select the monitors you want by checking the boxes
next to their names.
a. Click Multi-Edit.
Note: Multi-Edit only becomes available when the selected component monitors are of the
same type.
b. Check Statistic Threshold on the pop-up window, then check the Use thresholds calculated
from baseline data.
Note: The Use thresholds calculated from baseline data check box does not become available
until Statistic Threshold has been checked.
Note: Once Use thresholds calculated from baseline data is checked, the Warning and Critical
fields automatically populate with the macro, ${USE_BASELINE}.
5. Click Save, then click Submit.
402
4. If selecting only one Component Monitor, click [+] to expand the monitor details.
a. Click Override Template.
Note: The current values for the thresholds appear in the Warning and Critical fields
b. Click Use Latest Baseline Thresholds, as shown:
c. When applied, the values change and a blue icon appear indicating that baseline thresholds
are being used.
5. If selecting more than one component monitor, use the check boxes to select the monitors you want
to edit, and then click Multi-Edit.
a. Click Multi-Edit.
Note: Multi-Edit only becomes available when the selected component monitors are of the
same type.
b. Check the Statistic Threshold check box on the pop-up window, then check the Use
thresholds calculated from baseline data.
Note: Once the second box is checked, the Warning and Critical fields automatically populate
with the macro, ${USE_BASELINE}.
403
1. On the Web Console, click My Dashboards > Applications > SAM Summary.
2. From the All Applications resource, expand the tree and then click an application.
3. From the Application Details resource, click Edit Application Monitor.
4. Find a component monitor in the list and click [+] to expand the monitor details.
5. Click Override Template, then click Latest Baseline Details.
1. On the Web Console, click a node to navigate to the Node Details page for that node.
2. In the Management resource, click Edit Node.
3. Click Manage Orion General Thresholds.
4. The Capacity Planning options appear under each object:
5. Make your selections, then click Submit on both the Orion General Thresholds screen and the Edit
Properties screen.
404
View latest baseline details
Details about how baseline data, as well as Warning and Critical thresholds are calculated, can be found
on the Latest Baseline Details page. This page details the data collection and calculation process using
several graphs and tables.
405
Change between 32-bit and 64-bit polling
Using AppInsight applications with 32-bit polling on 64-bit computers via an agent prevents certain
performance counters from collecting information and should be changed to 64-bit polling.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click My Dashboards > Applications > SAM Summary.
2. Select an AppInsight Application (Exchange, SQL, IIS) and then click Edit Application Monitor.
3. Expand Advanced, and then click Override Template.
4. In the Platform to run polling job field, change the value to x64.
5. Click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select an AppInsight application and click Edit.
3. Expand Advanced, and in the Platform to run polling job on field, change the value to x64.
406
4. Click Submit.
407
Scan nodes for applications
SolarWinds SAM can scan nodes for you and automatically assign the Application Monitors it deems
suitable for each scanned node. You control the nodes to be scanned, the application templates used in
the scan, and the scanning parameters that determine a match.
You may need to log in with an administrator account to perform these actions.
1. On the Web Console, click Settings > All Settings > SAM Settings > Click Scan Nodes for Applications.
2. Follow the instructions in the Select Nodes Wizard.
3. Follow the instructions in the Select Applications Wizard.
4. Follow the instructions in the Enter Credentials Wizard.
5. Follow the instructions in the Review & Start Scan Wizard.
6. Follow the instructions in the Add UX Monitors Wizard.
Select Nodes
Click [+] in the list to expand the node groups and to select the nodes you want to scan.
Select Applications
To keep the time it takes to scan to a minimum, we recommend you initially scan for only a limited number
of application templates. To see more application templates, select a different template group from the
Show Only list.
To adjust the template assignment criteria, expand Advanced Scan Settings and move the slider to the
desired setting:
Exact Match
Strong Match
Partial Match
Minimal Match
408
Enter Credentials
Some application templates require credentials either to access restricted resources, or to run within the
context of a specific user. To scan for these templates, add the necessary credentials to the list. If a
template you are scanning for requires credentials, the credentials in this list are tried in the order in
which they appear.
Warning: Credentials are tried several times over the course of a scan, so an incorrect password is
likely to lock out an account. To avoid potential account lockouts that affect actual users, we
recommend you create and use service accounts. A service account is an account that is created
specifically for the purpose of providing credentials to use for SolarWinds monitoring. With service
accounts, no actual user is affected by an account lockout if a password should be entered
incorrectly.
If you have domains sharing user names with different passwords, we recommend you run separate
application discoveries for each domain.
Review the summary for the scan. If the automatic discovery matches templates that are already assigned
to the node, by default the template is not assigned a second time. If you want to assign duplicate
templates, select Yes, Assign Anyway from the Do you want to assign duplicates list.
Click Start Scan to begin the scan. The scan runs in the background. You are notified by a message near
the top of the window when scanning is completed. Click View results to see the results of the scan.
Add UX Monitors
You cannot scan for user experience (UX) monitors, but you can assign them to nodes manually. Adding
monitors from this page does not affect your scan.
409
Common Tasks with SolarWinds SAM
410
Create your first application and alert
After applied to a node, a template becomes an application, which is comprised of component monitors,
also known as performance counters. Applications created from templates are used to report metrics
based on your needs.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Create a New Template.
2. Name the template and click Add Component Monitor.
3. Select WMI Monitor, click Add.
4. Select credentials or Inherit Credentials from Node.
5. In the Query field, enter a WQL query to return a statistic to be reported.
6. Enter thresholds or select Use thresholds calculated from baseline data.
7. Click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Locate your template and click Assign to Node.
3. Select the Windows node from the left pane, click the green arrow to move it to the right pane, and
click Next.
4. Choose the credentials, click Assign Application Monitor, then click Done.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Alerts & Activity > Alerts > Manage Alerts.
2. Click Add New Alert and name the alert.
3. On the Properties tab, enter required information, and click Next.
411
4. For the Trigger Conditions, complete the section as shown:
Important: Add the second trigger condition by clicking [+]. The first trigger condition tests for Status
(Down), the second for the specific application instance (indicated by 1 Object).
5. For Trigger Actions, click Add Action, select Send an Email/Page, then click Configure Action.
6. Enter the required information, click Next and complete the wizard as instructed, then click Submit.
7. Review and edit the Reset Actions and the Summary, then click Submit.
8. The Manage Alerts page indicates the alert was created successfully.
412
Scan for applications worth monitoring
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Scan Nodes for Applications.
2. Select nodes by clicking [+] to expand the node groups, then select the nodes you want to scan, and
then click Next.
3. Select applications to find, and then click Next.
4. Enter the credentials for the servers you are scanning, and then click Start Scan.
5. Click View SAM Summary Page, then click View results after the SAM scan is complete.
413
Monitor a specific URL
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Add a Node.
2. Enter the Hostname or IP Address you want to monitor (for example, www.google.com).
3. Select External Node: No Status, and then click Next.
4. From the Show only: drop-down, select Web Pages.
5. Check Web Link and select Inherit credentials from Template.
414
Monitor VMware performance counters using an application monitor
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Component Monitor Wizard.
2. Select a VMware performance counter, then click Next.
3. Enter the IP address of the VMware node you want to browse, or click Browse, select the node from
the list, and then click Select.
4. Select or enter the appropriate credentials, then click Next.
5. Select whether you want to monitor A single system or Multiple systems.
6. Choosing A single system provides specific counters that apply to the target system only, choosing
Multiple systems provides more generic counters that can be applied to multiple systems.
Note: Choosing Multiple systems provides only aggregate performance counters (without instances).
Therefore, the Application Monitor created based on them can be considered as generic and
assigned to different ESX/vCenter target hosts. In this case, monitors in the application created
contain the special ${VMWARE_ENTITY_NAME} variable in the Entity Name field of the monitor.
When the monitor runs, this variable is resolved to the first available entity on a target host with the
desired Entity Type (for example, the first Host System).
8. Select the desired VMware Entity to monitor, then select the desired Performance Object (group) to
monitor.
9. Select the counters to monitor for the selected Performance Object, then click Next.
10. From the Edit Properties page you can modify settings as desired. When done, click Next.
1. Click [+] next to Component list to expand the list of counters or counters to be added.
2. Select New Application Monitor. Then enter a name for the new Application Monitor, then click Next,
then OK, Create.
3. Click View SAM Summary Page. Your new VMware monitor appears in the tree view for the All
Applications resource. The polling results for the new monitor are updated after a few minutes.
n Cluster Compute Resource (only available if the VMware vCenter Performance Counter Monitor type
is selected) – Data object that aggregates the computation resources of its associated Host System
objects into one single computation resource for use by virtual machines. The cluster services such
as HA (High Availability), DRS (Distributed Resource Scheduling), and EVC (Enhanced vMotion
Compatibility), enhance the usefulness of this single computation resource. This Entity Type is
specific to vCenter systems.
n Host System – Managed object type that provides access to a virtualization host platform.
415
n Resource Pool – Represents a set of physical resources which may be a single host, a subset of a
host's resources, or resources spanning multiple hosts. You can subdivide Resource pools by
creating child resource pools. In order to run, a virtual machine must be associated as a child of a
resource pool. In a parent/child hierarchy of resource pools and virtual machines, the root resource
pool is the single resource pool that has no parent pool.
n Virtual Machine – Managed object type for manipulating virtual machines, including templates that
can be repeatedly deployed as new virtual machines. This object type provides methods for
configuring and controlling a virtual machine.
416
Monitor and restart stopped Windows services
You may need to log in with an administrator account to perform these actions.
1. On the Web Console, click Settings > All Settings > SAM Settings > Component Monitor Wizard
2. Select Windows Service Monitor, and then click Next.
3. Enter the IP address of the Windows node you want to browse, or click Browse, select the node from
the list, then click Select.
4. Enter or select the appropriate credentials, then click Next.
5. Check the services to monitor, adjust thresholds as needed, then click Next.
6. Ensure that New Application Monitor Template Name is selected and then enter a name for your
new template, then click Next.
7. Select the desired nodes to monitor and then click Next.
8. Click OK, Create, to create the assigned Application Monitor.
Create an alert that restarts any stopped Windows services and sends an email
1. On the Web Console, click Alerts & Activity > Alerts > Manage Alerts.
2. Click Add New Alert > Configure Alerts.
3. Scroll to the bottom of the list in the Manage Alerts dialog, and check the box for Restart a service.
4. To send an e-mail notification for the service restart:
For more information about restarting Windows services with an alert action, see Adding Alert Actions.
417
Monitor large directories
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAMSettings > Create a New Template.
2. Name the template, click Add Component Monitor, then expand the Custom Component Monitors
group, select Windows Script Monitor, then click Submit.
3. Select credentials with appropriate permissions to run the script on the SolarWinds SAM server.
4. Copy the following Visual Basic script to get the directory size into the Script Body field:
Dim folderPath
folderPath = WScript.Arguments(0)
Set fs=WScript.CreateObject ("Scripting.FileSystemObject")
Set folder= fs.GetFolder(folderPath)
WScript.Echo "Message: Folder " &folderPath & " is " & folder.Size & "
bytes large"
WScript.Echo "Statistic: " & folder.Size
6. Enter the UNC path name for the directory to monitor into the Script Arguments field.
Use the variable ${IP} for the IP address of the target node to which the monitor is assigned when
the Windows Script monitor runs.
7. Specify the critical and warning thresholds for the desired directory size, then click Submit.
8. Create an assigned Application Monitor by assigning the Large Directory Monitor template to the
node.
a. On the Web Console, click Settings > All Settings > SAM Settings > Manually Assign Application
Monitors.
b. Select All in the Show only list, click Large Directory Monitor and then click Next.
c. Click Manually Assign Application Monitors and Select All in the Show only list.
d. Click Large Directory Monitor and then click Next.
e. Locate and select the desired node and then click Next.
f. Enter itadmin in the Credential Name field and then enter your credentials.
g. Click Test, click Assign Application Monitors, and then click Done.
a. Reads the first argument passed to the UNC path name for the directory to monitor and stores it in
FolderPath.
a. Retreives the folder name from the saved command line argument and stores it in folder.
b. Displays the message with the folder name and the folder size.
c. Displays the statistic (folder size in bytes).
418
The script does no error checking.
419
Monitor IIS application pools
SolarWinds SAM can monitor five instances, for example, of w3wp.exe, differentiated by application pools
separately if you specify the application pool names in the component monitors.
420
Manage Asset Inventory
The Asset Inventory dashboard lets you maintain a current and detailed inventory of your environment's
hardware and software. Automatic inventory data collection benefits those interested in tracking asset
depreciation, gathering information for insurance purposes, or managing and maintaining your
infrastructure.
421
Enable and disable the Asset Inventory dashboard
The Asset Inventory sub-view is automatically displayed for each node supported. You can enable Asset
Inventory data collection for an individual node via the Add Node Wizard or by navigating through the
Management resource.
The Asset Inventory option is available only if the node supports Asset Inventory polling.
The option to display Asset Inventory information may not be available if the node does not have a
supported operating system.
422
Asset Inventory data collection
Asset Inventory data collection is automatically enabled during the Network Sonar Discovery and/or the
upgrade process.
Data collected for Asset Inventory purposes uses less than 100KB of database space per node. For a larger
environment consisting of roughly 1,000 servers, the total Asset Inventory data should total just under
100MB.
Required sub-views are enabled by default for nodes with Asset Inventory enabled.
Inventory data does not need to be collected with the same degree of regularity as status information,
therefore, the impact on your polling engine is minimal. Asset Inventory data collection occurs once daily.
This data collection interval can be configured to suit your needs.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings >All Settings > Orion Polling Settings.
2. Adjust the number of days for the Default Asset Inventory Poll Interval field.
Note: 1 is the minimum allowable value for this field.
423
Manage AppStack
n Navigate to AppStack
n Use AppStack
n The AppStack environment
424
Navigate to AppStack
425
Use AppStack
Using AppStack as a troubleshooting tool is fairly straightforward. Simply navigate to the AppStack
Environment view, and then click on an object to see what is related to that object. To investigate further,
navigate to the Details page of the object or any related object.
For example, the illustration below displays all objects in the current environment. The application,
MSSQLSERVER, is in a Critical state, as indicated by its icon. To see what this application is related to, click
the MSSQLSERVER icon.
426
1. Once an object is selected, click Spotlight in the upper right-hand corner of the view.
1. Click the icon of the selected object to the left of the doughnut chart, or double-click the larger icon
in the main view.
2. From the Details page, investigate the cause for the Critical status.
427
Manage processes, services, tasks, and events in real time
n The Real Time Process Explorer
n The Service Control Manager
n The Windows Scheduled Task Monitor
n The Real Time Event Log Viewer
428
The Real Time Process Explorer
The Real Time Process Explorer (RTPE) is available for WMI and SNMP monitored nodes. The advantage of
the RTPE is that you no longer need to physically or remotely log in to a computer and run the Task
Manager to retrieve that machine's vital statistics. Information for monitored and unmonitored processes
is displayed directly through SAM using the RTPE.
Notes:
n Only SAM administrators can end processes as well as enable and disable the RTPE.
n The User Name and Command Line columns are hidden by default.
n Using the RTPE on a node monitored via ICMP, which has no working component, requires you to
select Windows credentials manually. Consider promoting the selected node to SNMP or WMI to
avoid this prompt.
429
Access the Real Time Process Explorer from the application details page
The Real Time Process Explorer (RTPE) is available for WMI and SNMP monitored nodes. The advantage of
the RTPE is that you no longer need to physically or remotely log in to a computer and run the Task
Manager to retrieve that machine's vital statistics.
Pop-ups must be enabled for the Real Time Process Explorer to be viewed.
The Real Time Process Explorer can also be accessed from the Component Details page and Node
Details page.
430
Monitor unmonitored processes
Processes currently monitored by SAM are indicated by the application icon and name of the assigned
application. Processes that are not currently monitored by SAM are indicated by the [+] symbol, followed
by the words, Start monitoring.
431
Use the Real Time Process Explorer
Different information is displayed in the RTPE depending on which protocol you use to monitor a node.
The table below shows the differences in the information gathered based on the protocol used.
Windows servers update their SNMP statistics every two minutes. It takes two updates to these statistics to
provide an accurate calculation. Data displayed in the RTPE via SNMP can take up to four minutes to
display.
* Information on certain processes may not be exposed which can result in certain rows being
blank.
By default, all available columns, with the exception of the User Name and Command Line, are
shown for the top ten running processes. Each column can be sorted, added, or removed by clicking
the column head and then clicking the drop down arrow.
Change the number in the text box next to the Show All button
Pause polling
432
End processes
Check the boxes next to the processes you want to end and then click End Process. This option
is only available when the RTPE is using a WMI connection.
Start polling
For Windows-based nodes, change the credentials by clicking the Use Different Credentials button to bring
up the credential library dialog box.
433
Real Time Process Explorer alerts
Three alerts are included with the Real Time Process Explorer
n High CPU Percent Utilization with Top 10 Processes
This alert sends an email when the CPU utilization is greater than 80%.
n High Physical Memory Utilization with Top 10 Processes
An alert is sent when physical memory usage is at or above 90%.
n High Virtual Memory Utilization with Top 10 Processes
An alert is sent when virtual memory usage is at or above 90%.
These alerts can be found in the Alert wizard. For more information, see Adding Alerts.
Alerts may lag if you are monitoring hardware via SNMP. It takes two updates to these statistics to
provide an accurate calculation, meaning an alert can take up to four minutes to reach its recipient.
To expedite this process, change the protocol to WMI, which updates every five seconds. Also,
consider adjusting the trigger time to a value greater than two minutes.
434
Real Time Process information in top 10 alerts
SAM provides additional troubleshooting information for high CPU, memory, and virtual memory by
sending email alerts. This is done by utilizing the Top Offending Processes metric running on the server at
the time of the alert.
Variable Definition
Process:
n CPU - Processor time. This is the default value if the command line argument is
not specified.
n PhysicalMemory - Process physical memory.
n VirtualMemory - Process virtual memory.
n DiskIO - Process disk I/O per second.
-alert The AlertDefID of associated triggered alert. If this argument is provided, then alert notes
are updated with the results from polling.
-activeObject The ActiveObject property of the associated triggered alert. If this argument is not
provided, NodeID is used.
Example 1
This example returns the top 20 processes with the highest virtual memory consumption running on
the host with node ID 123.
Example 2
This example uses the Execute an External Program alert action:
435
SolarWinds.APM.RealTimeProcessPoller.exe -n=${NodeID} -alert=${AlertDefID}
Example 3
This example uses the Execute an External Program alert action for an alert defined for the Volume
object type:
SolarWinds.APM.RealTimeProcessPoller.exe -n=${NodeID} -alert=${AlertDefID} -
activeObject=${NetObjectID} -sort=VirtualMemory
436
The Service Control Manager
The Service Control Manager (SCM) is similar to the Real Time Process Explorer, except with the SCM you
manage the services of monitored Windows nodes instead of processes. The advantage of the SCM is that
you no longer need to physically, or remotely, log in to a Windows computer to view and control its
services. Information for running and stopped services is displayed directly through SAM using the Service
Control Manager.
Services viewed in the Service Control Manager are polled every 25 seconds using WMI.
437
Access the Service Control Manager (SCM) from the Node Details page
You may need to log in with an administrator account to perform this action.
The Service Control Manager button is not available on the Node Details page in situations where
Top 10 lists are hidden. Clicking Service Control Manager opens the SCM in a new window and the
services are sorted alphabetically.
Pop-ups must be enabled in your browser to view the Service Control Manager.
438
Use the Service Control Manager
The Service Control Manager (SCM) shows all the services that are on the monitored computer. Hovering
the mouse over the row of any service will give you detailed information about that service.
Services monitored by SAM are indicated by the application icon and name of the assigned application.
Services that are not monitored by SAM are indicated by the [+] symbol, followed by the words, Start
monitoring this service.
1. Click Start monitoring this service in the row of the service to monitor.
2. The Edit Properties section of the Component Monitor wizard opens. Begin customizing the selected
component monitor.
The table below shows the default settings for the Service Control Manager:
Service Job Life Time This is used to specify how long the information for a service 3 minutes
exists.
Service Poll Interval This is used to specify the refresh frequency of the 25 seconds
information reported by the service.
Service Action Job This reports the timeout for a service. 3 minutes
Timeout
439
The Windows Scheduled Task Monitor
The Windows Scheduled Task Monitor (WSTM) is a resource designed to provide you with quick visual
access to the status of scheduled tasks configured on your Windows nodes.
Only tasks from root directory can be monitored. The WSTM will not work for tasks from every level
of the Task Scheduler Library.
The WSTM comes with an alert that will notify you of any task execution failures, as well as web-based
reports that show all scheduled tasks configured across all servers in your environment. Additionally, there
is a dedicated Task Failure Report you can view on-screen or have emailed to you.
This resource is hidden when the WSTM is not being monitored on a node.
440
Requirements for the Windows Scheduled Task Monitor
Notes:
n When SAM is installed on Windows 2003 R2 SP2, scheduled tasks on Windows 2008 or later cannot
be polled by the Windows Scheduled Task Monitor (WSTM).
n The WSTM consumes five license units per node.
n Only tasks from root directory can be monitored. The WSTM will not work for tasks from every level of
the Task Scheduler Library.
441
Enable the Windows Scheduled Task Monitor
You may need to log in with an administrator account to perform this action.
The Windows Schedule Tasks option is checked when tasks are already being monitored, is
unchecked by default when at least one task is found on the target machine, or is hidden when a
task is not found on the target machine.
442
Access the Windows Scheduled Task Monitor
1. On the Web Console, click My Dashboards > Home > All Nodes resource.
2. Expand the Windows tree by clicking Windows, and then click a Windows node to be taken to the
Node Details page for that node.
3. On the Node Details page, find the Windows Scheduled Task resource, as shown:
When monitored, the Windows Schedule Task Monitor resource is only on the Node Details view of
the monitored server.
443
Understand the Windows Scheduled Task Monitor
Only tasks from root directory can be monitored. The WSTM will not work for tasks from every level of the
Task Scheduler Library.
n Hovering over any item in the Task Name column will provide detailed information about the listed
task.
n Sort the display by clicking the head of each column.
n From Edit Settings, at the bottom of the resource, you can:
n Change the polling frequency
n Change the polling timeout period
n Change credentials
n Add custom notes
444
Alert using Windows Scheduled Task Monitor macros
This alert is associated with the Windows Scheduled Task Monitor and can be used in alerting.
445
Windows Scheduled Task Monitor returned status codes
Below is a list of status codes and their meanings that may appear in the WSTM resource:
Hex Status
Description
Code
(0x41302) The task will not run at the scheduled times because it has been disabled.
One or more of the properties that are needed to run this task on a schedule have not
(0x41305)
been set.
(0x41306) The last run of the task was terminated by the user.
(0x41307) Either the task has no triggers or the existing triggers are disabled or not set.
(0x4131B) The task is registered, but not all specified triggers will start the task.
The task is registered, but may fail to start. Batch log in privilege needs to be enabled for
(0x4131C)
the task principal.
(0x41325) The Task Scheduler service has asked the task to run.
(0x8004020D) Cannot modify or delete an object that was not added using the COM+ Admin SDK.
(0x8004130A) One or more of the properties required to run this task have not been set.
446
(0x8004130E) The object is either an invalid task object or is not a task object.
No account information could be found in the Task Scheduler security database for the
(0x8004130F)
task indicated.
Corruption was detected in the Task Scheduler security database. The database has
(0x80041311)
been reset.
(0x80041312) Task Scheduler security services are available only on Windows NT.
The task has been configured with an unsupported combination of account settings and
(0x80041314)
run time options.
(0x80041317) The task XML contains an element or attribute from an unexpected namespace.
(0x80041318) The task XML contains a value which is incorrectly formatted or out of range.
(0x8004131D) The task XML contains too many nodes of the same type.
(0x8004131E) The task cannot be started after the trigger end boundary.
(0x80041320) The task will not run because the user is not logged in.
(0x80041323) The Task Scheduler service is too busy to handle your request. Please try again later.
The Task Scheduler service attempted to run the task, but the task did not run due to
(0x80041324)
one of the constraints in the task definition.
(0x80041327) The task has properties that are not compatible with earlier versions of Windows.
(0x80041328) The task settings do not allow the task to start on demand.
447
(0x800704C7) The operation was canceled by the user.
The operation being requested was not performed because the user has not logged on
(0x800704DD)
to the network. The specified service does not exist.
For a complete list of error codes, see Task Scheduler Error and Success Constants.
448
WTSM status
The following table lists the conditions that must be met in order for a status of Available, Not Available, or
Undefined, to be triggered:
Unexpected Node
Name space
Invalid Value
Missing Node
Malformed XML
Already Running
449
Service Too Busy
Task Attempted
Start On Demand
No File Specified
Incorrect Function
Environment Is Incorrect
Application Terminated
Operation Canceled
450
The Real Time Event Log Viewer
View Windows event logs in real time using the WMI protocol with the Real Time Event Viewer (RTEV). Event
logs can be filtered by log type, event source, and the level of severity. You can also select which event logs
you want to monitor from within this resource.
451
Access the Real Time Event Viewer from the Node Details page
You may need to log in with an administrator account to perform this action.
452
Filter events in the Real-Time Events Viewer
Different events are displayed in the RTEV depending on the log type and filters you choose. After you
select a Log Type from the drop-down list, SAM immediately begins collecting these logs and display them
in the message window to the right, as shown:
After the events of the selected Log Type are collected and displayed in the window on the right, you can
filter the results with various criteria.
1. Select Custom Sources from the Event Sources drop-down menu.
2. Select only the sources you want to keep when the filter is applied, as highlighted below:
453
3. Select the type of messages you want the filter to keep by selecting the Event Level.
4. Click Apply Filter to have the events filtered and displayed.
454
Reading events in the Real-Time Events Viewer
After filtering is complete, hide and unhide the filtering pane on the left by clicking either of the two
arrows, highlighted in red:
The display window shows a list of the most recent events. Should any new events occur while this window
is open, a green bar at the top of the window indicates that new events have arrived. Click the green bar to
add these new events to the display window.
The Level column icons correspond to the Event Level icons in the legend of the events pane.
Clicking any message in the display window brings up a message box providing the entire message along
with additional details.
455
Monitor events in the Real-Time Events Viewer
Begin monitoring events from within the RTEV by clicking Start Monitoring in the Message Details view.
This takes you to the Add Component Monitor wizard and lets you to create an application based on your
selection.
After you begin the Component Monitor Wizard, you encounter the option to Disable Keyword Matching.
the Include Events drop-down menu will help you filter results.
456
Manage audit events
SAM offers the ability to audit itself. For example, you may want to know who added a node to SAM and
when. The Last 10 Audit Events resource provides this ability.
This resource is only available for users with administrative rights. You may need to log in with an
administrator account to perform this action.
From this view, you can click on either the user or the node which is linked to more information about that
particular item. Clicking All Audit Events will allow you to select the audit events you want displayed, in
addition to other self-explanatory options. Refer to the following topics for additional information:
1. On the Web Console, click My Dashboards > Home > Customize Page.
2. Click the [+] in any column and search for Audit.
3. Select the resources wanted, and then click Add Selected Resources, then click Done.
457
Filter audit events
SAM allows you to filter Audit Events based on device, time, and message.
1. From the Audit Events resource, click All Audit Events.
2. Select the filters you want to apply by checking the appropriate boxes and items from the drop down
menus, as highlighted below, and then click Apply.
Click Edit to choose the audit events you want displayed in addition to selecting the time period for the
events, as well as the number of events to display.
458
Manage SolarWinds SAM polling engines
To ensure that your polling engines are optimized to run at peak performance, you need to occasionally
tune them. If you use more than one polling engine, you need to balance the load so that each engine can
perform optimally.
459
View polling engine status
The Polling Engines view provides information about the performance of all polling engines in your Orion
Platform product installation.
To access the Polling Engine view, click Settings, then Polling Engines in the Details group.
460
Configure polling engine settings
Settings for your SolarWinds SAM polling engine are configured on the SolarWinds Polling Settings view
within the SolarWinds Web Console.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Polling Settings.
2. Adjust the settings as needed, and then click Submit.
461
SolarWinds polling settings
The following poller settings are configurable on the SolarWinds Polling Settings view.
n Polling intervals
n Polling statistics intervals
n Network
n Calculations & Thresholds
462
Polling intervals
The following settings configure default polling intervals. To apply poller settings, click ReApply Polling
Intervals.
Devices are regularly polled to determine status and response time on this designated interval. By
default, this interval is 120 seconds.
Volumes are regularly polled to determine status and response time on this designated interval. By
default, this interval is 120 seconds.
Your entire network is polled on this interval to detect any re-indexed devices. Monitored network
devices are also checked for IOS upgrades permitting EnergyWise support. By default, this interval is
30 minutes.
This option is enabled by default. Enabling this option automatically saves any polling
customizations made on the SolarWinds Polling Settings view.
463
Polling statistics intervals
The following settings configure default polling intervals for device statistics. To apply poller settings, click
ReApply Polling Statistic Intervals.
Device performance statistics are regularly polled on this interval. By default, this interval is 10
minutes.
Volume performance statistics are regularly polled on this interval. By default, this interval is 15
minutes.
464
Network
ICMP Timeout
All ICMP (ping) requests made by the SolarWinds poller time out if a response is not received within
the period designated. By default, this period is 2500ms.
ICMP Data
SNMP Timeout
All SNMP requests made by the SolarWinds poller time out if a response is not received within the
period designated. By default, this period is 2500ms.
SNMP Retries
If a response to an SNMP poll request made by the SolarWinds poller is not received within the
configured SNMP Timeout, the SolarWinds poller will conduct as many retries as designated by this
value. By default, this value is 2.
465
Calculations & Thresholds
The following settings designate methods for calculating availability and transmission rate baselines,
select the SolarWinds SAM node warning level and counter type, and indicate security preferences for
community strings and other potentially sensitive information in the web console.
This setting designates the type of calculation SolarWinds SAM performs to determine device
availability. For more information, see Calculate node availability.
Upon startup, SolarWinds can calculate a baseline for the transmission rates of the various elements
of your network. This baseline is used as a starting point for any comparison statistics. For more
information, see Calculate a baseline.
In the interest of security, sensitive information about your network is not viewable in the SolarWinds
Web Console. However, if your network is properly secured, you may check this option to allow the
viewing of community strings and other potentially sensitive information within the web console.
This setting does not affect the display of custom reports that you export to the web. For more
information see Creating and Editing Web Based Reports.
Devices that do not respond to polling within this designated period of time display as Down in the
web console. By default, this value is 120 seconds.
Counter Rollover
This option sets the type of counter SolarWinds SAM is to use. For more information, see Manage
counter rollovers.
466
Calculate a baseline
Much of the raw data that SolarWinds SAM polls from nodes is provided initially as counter values. If you
do not need statistics immediately, or if you do not want SolarWinds SAM to calculate a baseline at startup,
disable baseline calculation at startup by setting the Baseline Calculation option on the SolarWinds Polling
Settings view to False.
Baseline calculation requires significant data gathering and processing. Until baseline calculation is
completed, both SolarWinds SAM server performance and the CPU performance of some of network
routers may be adversely affected.
467
Set the node warning level
A device may drop packets or fail to respond to a poll for many reasons. Should the device fail to respond,
the device status is changed from Up to Warning. On the SolarWinds Polling Settings view, you can specify
the Node Warning Level, which is the length of time a device is allowed to remain in the Warning status
before it is marked as Down. During the interval specified, the service performs "fast polling" (ICMP) to
continually check the node status.
You may see events or receive alerts for down nodes that are not actually down. This can be caused
by intermittent packet loss on the network. Set the Node Warning Interval to a higher value to avoid
these false notifications. For more information about packet loss reporting, see Manage packet loss
reporting. You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Polling Settings.
2. In the Calculations and Thresholds group, set the Node Warning Level to an appropriate interval, in
seconds.
Note: The default Node Warning Level interval is 120 seconds.
3. Click Submit.
468
Use the polling engine load balancer
The Polling Engine Load Balancer is a useful tool for reassigning nodes to a new polling engine, deleting an
unused polling engine, and performing load balancing between multiple polling engines. The tool is
available within the Monitor Polling Engines application, which is an advanced feature of SolarWinds SAM.
Reassigning nodes to new polling engines may be required in the following situations:
If these or any other conditions present the need for reassignment, complete the following procedure to
reassign nodes to a new polling engine.
1. Click Start > All Programs > SolarWinds > Advanced Features > SolarWinds Service Manager.
2. Click Shutdown Everything.
Note: Confirm that you stop the SolarWinds Network Performance Monitor Service on all polling
engines.
3. Click Start > All Programs > SolarWinds > Advanced Features > Monitor Polling Engines.
4. Click Servers > Poller Load Balancing.
5. Select the nodes you want to reassign.
Note: Use Shift + click to highlight multiple consecutive rows, and use Ctrl + click to highlight
multiple non-consecutive rows.
6. Click Polling Engines > Move Selected Nodes to *, substituting the target polling engine for *. The
node is reassigned, and it reflects the name of the polling engine in the polling engine column.
7. Click Start > All Programs > SolarWinds > Advanced Features > SolarWinds Service Manager to
restart SolarWinds services.
469
Manage packet loss reporting
To manage the amount of network-wide packet loss reported by SolarWinds, configure the Response Time
Retry Count for your polling engine. This setting designates the number of times SolarWinds retries ICMP
pings on a monitored device before packet loss is reported.
This configuration change requires an insertion into your Orion database. If possible in your
environment, SolarWinds recommends installing and using the SQL Server Management Studio to
perform this insertion.
Configure the response time retry count for your polling engine
470
Calculate node availability
The Availability Calculation setting on the SolarWinds Polling Settings view provides a choice between the
following two methods for determining device availability.
Node Status
The default method is based upon the historical up or down status of the selected node. The selected
node is polled for status on the Default Node Poll Interval defined on the SolarWinds Polling Settings view.
If the selected node responds to a ping within the default interval, the node is considered up, and a value
of 100 is recorded in the Response Time table of the Orion database. If the node does not respond to a
ping within the default interval, the node is considered down and a value of 0 is recorded in the Response
Time table of the Orion database. To calculate node availability over a selected time period, the sum of all
Response Time table records for the selected node over the selected time period is divided by the selected
time period, providing an average availability over the selected time period.
The second method is a more complicated calculation that effectively bases the availability of a selected
node on its packet loss percentage. As in the Node Status method, the selected node is polled for status. If
it responds within the Default Node Poll Interval defined on the SolarWinds Polling Settings view, a value of
100 is averaged with the previous 10 availability records.
The result of the Percent Packet Loss calculation is a sliding-window average. To calculate node availability
over a selected time period, the sum of all results in the Response Time table for the selected node over
the selected time period is divided by the selected time period, providing an average availability over time.
Note: The Percent Packet Loss method introduces a historical dependency into each availability node
record. In general, it is best to leave calculations based on Node Status unless you specifically need node
availability based on packet loss.
Calculating a Baseline
Much of the raw data that SolarWinds SAM polls from nodes is provided initially as counter values. If you
do not need statistics immediately, or if you do not want SolarWinds SAM to calculate a baseline at startup,
disable baseline calculation at startup by setting the Baseline Calculation option on the SolarWinds Polling
Settings view to False.
Baseline calculation requires significant data gathering and processing. Until baseline calculation is
completed, both SolarWinds SAM server performance and the CPU performance of some of network
routers may be adversely affected.
For more information, see Change the amount of data used in baseline calculations.
471
AppInsight for Exchange
AppInsight for Exchange was designed exclusively for the mailbox role which offers a detailed view of your
Exchange environment. This application provides detailed metrics on mailboxes, databases, and a host of
performance counters without the use of agents or templates. Use Applnsight for Exchange to monitor
virtually every aspect of your Exchange environment.
After it is applied to a node, AppInsight for Exchange is considered an application. AppInsight for Exchange
is comprised of multiple component monitors.
To optimize your Exchange server performance, see 5 Tips to Optimize Exchange Server for
Improved Performance.
472
Quick configuration - AppInsight for Exchange requirements and permissions
n Local administrator permissions are needed for automatic configuration, but they are not needed for
monitoring after configuration is complete.
n To provide organization-wide capability, the service account (Domain User) needs to be a member of
the View-Only Organization Management group. Membership to this group gives the user object
read-only access to the entire Exchange environment, without providing any domain or local access
on the Exchange server. It also prevents abuse by an unauthorized user, for example (modifying
Exchange environment configuration, creating or deleting users, and so on.)
n In order to gather information, the user object must be assigned the Mailbox Search management
role within Exchange. In order for the account to be configured correctly, the account must be a
member of the Local Administrators group.
473
Add AppInsight for Exchange to a node
It is recommended that you add this application on WMI managed nodes. If you convert an SNMP
managed node to WMI, interface statistics become lost. To convert SNMP managed nodes to WMI, see
Promoting a Node to WMI Monitoring.
1. On the Web Console, click Settings > All Settings > Add a Node.
2. Complete the information on the Define Node step, and then click Next.
3. On the Choose Resources step in the Configuration Wizard, select the AppInsight for Exchange
applications you want. AppInsight applications have a unique blue and white icon.
4. Click Next and complete the wizard as instructed.
5. Navigate to the All Applications resource and click your AppInsight for Exchange application.
6. Enter your Exchange credentials when prompted, and then click Configure Server.
474
Navigate the AppInsight for Exchange pages
AppInsight for Exchange can be found in the All Applications resource on the Application Summary view.
You may need to log in with an administrator account to perform this action.
1. On the web console, locate the All Applications resource by clicking My Dashboards > Applications
> SAM Summary.
2. Expand the AppInsight for Exchange tree and click [+].
3. Expand the node tree, click [+], and then click the application.
From the AppInsight for Exchange Details view, click any performance counter within a resource.
475
View the AppInsight for Exchange Database Details page
From the AppInsight for Exchange Details view, click any database within a Database resource.
From the AppInsight for Exchange Details view, click any user name within a Mailbox resource.
476
Advanced Manual Configuration of AppInsight for Exchange
477
Changes that will be made to enable AppInsight for Exchange
The configuration tool first transfers to the Exchange Server by using the Windows administrative share.
Once on the Exchange Server, the tool uses a custom PowerShell script to make configuration changes.
SAM will add the Mailbox Search Role to the Exchange server with the credentials provided. The tool then
reports back to SAM with the results. If errors are reported, you will be asked to configure Exchange.
n WinRM 2.0
n PowerShell v2.0
n IIS
n Enable WinRM
n Enable Windows Authentication for PowerShell's web site
n WinRM and Windows Authentication configurations are performed remotely from SAM
SAM uses a specially designed configuration tool to make the necessary changes for enabling
AppInsight for Exchange. Once this tool completes remote configuration, it will automatically
remove and unregister itself.
478
Find Exchange credentials
The verify you have valid Exchange credentials, run the following cmdlet in the Exchange Management
Shell (EMS):
479
Manually configuring the Exchange server
To manually prepare an Exchange server for AppInsight for Exchange, the following items must be
installed and/or configured on the server. Instructions for each item are listed on this page below.
For a list of possible configuration errors with solutions, see Troubleshoot error codes in AppInsight for
Exchange.
Non-Domain Account
Local accounts (Non-Domain) cannot access Exchange Management interfaces and therefore are not
supported by AppInsight for Exchange. Please select an Active Directory account or create a new one to
use with AppInsight for Exchange.
1. On the server where you wish to grant local administrative privileges, open a Computer Management
console.
Note: On Windows 2012, add this privilege using the Active Directory console.
2. Navigate to the Administrators group.
3. Add the type in the Active Directory user name of the account you want to grant administrative
privileges. (Ensure the location is set to either the domain where the account is located or Entire
Directory.)
4. Save your changes.
Alternatively, you can add an Active Directory group to the local administrators group and add the
Active Directory user accounts to that group.
To verify the account and local group membership has been configured properly, run the
following in a PowerShell session
480
$Recurse = $true
$GroupName = 'Administrators'
Add-Type -AssemblyName System.DirectoryServices.AccountManagement
$ct = [System.DirectoryServices.AccountManagement.ContextType]::Machine
$group =
[System.DirectoryServices.AccountManagement.GroupPrincipal]::FindByIdentity
($ct,$GroupName)
$LocalAdmin = $group.GetMembers($Recurse) | select @{N='Domain'; E=
{$_.Context.Name}}, samaccountName, @{N='ObjectType'; E=
{$_.StructuralObjectClass}} -Unique
$LocalAdmin = $LocalAdmin | Where-Object {$_.ObjectType -eq "user"}
Exchange Access
Granting Least Privilege access to the Exchange Organization can be accomplished using Active Directory
Users and Computers (ADUC).
1. Open Active Directory Users and Computers (ADUC) and find he Microsoft Exchange Security Groups
OU.
2. From the View-Only Organization Management group, add the user name of the account you want to
grant access to the Exchange organization.
Mailbox Search access is required to determine attachment counts and sizes. This can be granted using
the Exchange Management Shell (EMS).
481
1. From the Start menu, open the EMS.
2. Type: New-ManagementRoleAssignment -Role "Mailbox Search" -User <Username of
account being granted access> and then press Enter.
3. To verify the management role has been properly assigned, enter the following command:
Get-ManagementRoleAssignment -RoleAssignee <Username of account>
PowerShell 2.0 is automatically installed on Server 2008 R2 and therefore no additional installation
is required.
1. Determine whether or not PowerShell 2.0 is installed. Typically, this can be done from the Server
Manager.
2. Ensure that PowerShell 2.0 is fully installed.
1. The can be done on the IIS Manager on the Exchange server for the application settings of the
default website and PowerShell virtual directory.
2. You need to recycle the MSExchangePowerShellAppPool application pool.
SolarWinds has created a PowerShell script to create a self-signed certificate suitable for AppInsight for
Exchange. This can be found at: Self-signed Certificate PowerShell script for AppInsight for Exchange. If
you choose not to download this script, you can create your own self-signed certificate with the following
instructions and code:
1. To create a self-signed certificate using PowerShell and CertEnroll, open PowerShell in the Run as
Administrator context.
2. Enter the following code:
Note: The CN (Subject) should be in the following format: "<IP Address of Server>_
Solarwinds_Exchange_Zero_Configuration."
For Example: “10.199.15.106_Solarwinds_Exchange_Zero_Configuration”
482
$name = new-object -com
"X509Enrollment.CX500DistinguishedName.1"
$name.Encode("CN=TestServer", 0)
WinRM 2.0
1. To configure WinRM on an Exchange server, open a command prompt in the Run as Administrator
context.
483
2. Type: winrm create winrm/config/listener?Address=*+Transport=HTTPS @
{Port="5986";CertificateThumbprint="<Thumbprint value of
certificate>";Hostname="<IP Address of Server>_Solarwinds_Exchange_Zero_
Configuration"} and then press Enter.
function Add-FirewallRule {
param(
$name,
$tcpPorts,
$appName = $null,
$serviceName = $null
)
$fw = New-Object -ComObject hnetcfg.fwpolicy2
$rule = New-Object -ComObject HNetCfg.FWRule
$rule.Name = $name
if ($appName -ne $null) { $rule.ApplicationName = $appName }
if ($serviceName -ne $null) { $rule.serviceName = $serviceName }
$rule.Protocol = 6 #NET_FW_IP_PROTOCOL_TCP
$rule.LocalPorts = $tcpPorts
$rule.Enabled = $true
$rule.Grouping = "@firewallapi.dll,-23255"
$rule.Profiles = 7 # all
$rule.Action = 1 # NET_FW_ACTION_ALLOW
$rule.EdgeTraversal = $false
$fw.Rules.Add($rule)
}
484
3. Run the function to create the firewall exception for WSMAN using the following command:
Add-FirewallRule "Windows Remote Management" "5986" $null $null
Configure IIS
485
6. Type: (Get-WebConfiguration
system.webServer/security/authentication/windowsAuthentication
'IIS:\sites\Default Web Site\PowerShell').enabled and then press Enter to
determine if Windows Authentication has been configured.
a. If the value returned is True, you do not need to do anything.
b. If the value returned is False, then take the following steps:
i. Type: Set-WebConfiguration
system.webServer/security/authentication/windowsAuthentication
'IIS:\sites\Default Web Site\PowerShell' -value True and then press
Enter.
ii. Type: (Get-WebConfiguration
system.webServer/security/authentication/windowsAuthentication
'IIS:\sites\Default Web Site\PowerShell').enabled to verify the setting
has changed.
486
Test the application
1. When you are finished with configuration, navigate to the Application Edit page and click Test.
2. If successful, your screen should look like the illustration below:
487
Set PowerShell permissions
If PowerShell 2.0 was installed on Windows Server 2012 with Exchange 2013 and subsequently
uninstalled, a Microsoft error removes the required registry key for remote PowerShell to work
properly. Security patches or updates may also cause this issue. You can create the required
registry key by following these instructions:
1. Open Notepad and copy and paste the following text .
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PowerShell\1\PowerShellEngine]
"ApplicationBase"="C:\\Windows\\System32\\WindowsPowerShell\\v1.0"
"PSCompatibleVersion"="1.0, 2.0"
"RuntimeVersion"="v2.0.50727"
"ConsoleHostAssemblyName"="Microsoft.PowerShell.ConsoleHost,
Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35,
ProcessorArchitecture=msil"
"ConsoleHostModuleName"="C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\Mi
crosoft.PowerShell.ConsoleHost.dll"
"PowerShellVersion"="2.0"
2. Save the file as PowerShellv1.reg and then double-click it to add it to the registry. (A reboot
may be required.)
488
Find Exchange URL settings
By default, AppInsight for Exchange uses the following URLs for the Exchange and WinRM sessions, where
${IP} is the IP address of the server node being added.
Exchange: https://${IP}/powershell/
WinRM: https://${IP}:5986/wsman/
1. Open IIS Manager and navigate to the default website, and then navigate to the PowerShell virtual
directory.
2. Verify the Virtual Path value (typically in the Advance Settings).
The two items of interest for the URL are Port and URLPrefix. If either of these have been modified and do
not match the default values, edit the AppInsight for Exchange application with the correct values.
489
Additionally, the value of Hostname must match the CN of the certificate listed in the Certificate
Thumbprint property.
490
n Non-Domain Account
n Set PowerShell permissions
491
Edit the AppInsight for Exchange template
The AppInsight for Exchange application behaves like any other application in SAM. And like other
applications, AppInsight for Exchange's template can be edited.
Some limitations may apply. You may need to log in with an administrator account to perform this
action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the AppInsight for Exchange template in the list and then click Edit.
3. From here, you can edit certain component monitors within the template.
4. When done editing, click Submit at the bottom of the page.
492
Attachment extensions acknowledged by AppInsight for Exchange
The following table lists the default attachment extensions that are acknowledged by AppInsight for
Exchange:
493
AppInsight for IIS
AppInsight for IIS is considered a template until it is applied. Therefore, it is a member of the Application
Monitor Templates collection. Once applied to a node, AppInsight for IIS is considered an application. Like
any SAM application, AppInsight for IIS is comprised of multiple component monitors.
The following reports are installed for use with AppInsight for IIS:
494
Quick configuration and navigation
Configuration of SAM's AppInsight for IIS is most easily achieved via Discovery, as shown below.
n To add AppInsight for IIS, see Add AppInsight for IIS to a node
495
Add AppInsight for IIS to a node
3. Select Microsoft IIS to enable AppInsight for IIS data collection. When done, click Submit.
4. Navigate to the All Applications resource to verify the addition by clicking the Applications tab in the
web console.
5. Click on the newly added AppInsight for IIS application in this view and then enter your IIS
credentials when prompted.
6. Once your credentials are entered, click Configure Server.
496
Edit the AppInsight for IIS template
The AppInsight for IIS application behaves like any other application in SAM. And like other applications,
the AppInsight for IIS template can be edited.
Some limitations may apply. You may need to log in with an administrator account to perform this
action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the AppInsight for IIS template in the list and then click Edit.
3. From here, you can edit certain component monitors within the template; including threshold values,
number of records to retrieve, component monitor description, and so on.
4. When done editing, click Submit at the bottom of the screen.
497
Navigate the AppInsight for IIS details view
AppInsight for IIS acts like any other application and can therefore be found in the All Applications
resource on the Application Summary view.
The default IIS Application name is Microsoft IIS. You may need to log in with an administrator
account to perform these actions.
From the AppInsight for IIS details view, click a website in the Sites resource.
From the AppInsight for IIS details view, click an application pool in the Application Pool resource.
From the AppInsight for IIS details view, click a performance counter in any resource.
498
Manually configure AppInsight for IIS
In the event automatic configuration of AppInsight for IIS failed, visit the sections below in order and take
the steps outlined to manually configure the remote computer.
For automatic AppInsight for IIS configuration see, Quick configuration and navigation.
Important: Ensure that Windows Remote Management (WS-Management) is running and that this
service's Startup Type property is set to Automatic. Once this is verified, continue manual
configuration in the order listed below:
1. The following procedures outline the installation of PowerShell and the required snapins.
2. Set execution policy on the target computer
3. Create a self-signed certificate
4. Create a firewall rule
5. Update WsMan limits
6. Important: If you received the following error: An HTTPS listener currently exists on port 5986, use
the following steps to configure the listener on an available port by changing "5986" to an available
port number throughout these steps.
499
Install PowerShell 2.0 and the WebAdministration snapin
The following procedures outline the installation of PowerShell and the required snapins.
The following steps are not necessary for Windows Server 2008 R2 and Windows Server 2012.
Installation of PowerShell 2.0 can typically be done from the Server Manager as shown below. For
installation instructions, visit www.microsoft.com
For Managed Nodes with IIS 7.0, download and install the PowerShell WebAdministration snapins found at
the following link: http://www.iis.net/learn/manage/powershell/installing-the-iis-powershell-snap-in.
500
n IIS 7.0
1. The IIS PowerShell Snap-in is available as x86 and x64 version. Download the 32-Bit
version or 64-Bit version.
2. Run the MSI file to install the IIS PowerShell Snap-in.
PowerShell snap-ins like the IIS PowerShell Snap-in have to be registered with PowerShell.
There are two ways to do this:
The IIS PowerShell snap-in setup creates a new program menu shortcut. By starting this
shortcut, the IIS PowerShell snap-in is registered automatically. Navigate to Start > All
Programs > IIS 7.0 Extensions > IIS PowerShell Management Console. The prompt of the
new PowerShell command window is set to "IIS:\" - the root of the IIS snap-in namespace.
If you want to use the IIS PowerShell snap-in from an existing PowerShell command
window, you have to register the IIS snap-in manually. You can do this by simply
executing the IISConsole.PSC1 file located in the
$env:programfiles\IIS\PowerShellProvider directory:
501
Set execution policy on the target computer
1. Open a PowerShell session in the Administrator context (Right-click and select Run as Administrator).
2. Enter the following command: Set-ExecutionPolicy RemoteSigned
502
Create a self-signed certificate
SolarWinds has created a PowerShell script to create a self-signed certificate suitable for AppInsight for IIS.
This can be found at:
https://support.solarwinds.com/Success_Center/Server_%26_Application_Monitor_(SAM)/AppInsight_for_
IIS:_Create_certificates
Once downloaded, execute the script by right-clicking it and selecting, Run with PowerShell. The following
parameters apply:
n IP address: Mandatory
n Certificate lifetime in days: Optional
You can run this script with the default arguments from the PowerShell console or specify each one.
For example:
& '.\Create self-signed certificate script.ps1' 192.168.2.69 3650
where 192.168.2.69 is the IP address of the node to be monitored by AppInsight for IIS and 3650 is
3,650 days (10 years).
503
Create a firewall rule
SolarWinds has created a PowerShell script to create a firewall rule. This can be found at:
https://support.solarwinds.com/?title=Success_Center/Server_%26_Application_Monitor_(SAM)
/AppInsight_for_IIS:_Create_a_firewall_rule
Once downloaded, execute the script by right-clicking it and selecting, Run with PowerShell. The following
parameters apply:
n Without parameters: The rule is created with the default name, "Windows Remote Management
HTTP/SSL" for port 5986.
n With one parameter: Non-default custom port.
n With two parameters: Non-default custom port and rule name
You can run this script with the default arguments from the PowerShell console or specify each one.
For example:
& '.\Add firewall rule.ps1' 5988 "My custom firewall rule name"
The default port for this rule is 5986 and does not need to be specified. Custom ports, as in the
example above that uses port 5988, must be specified.
504
Update WsMan limits
WsMan provides methods and properties used to create a session. SolarWinds has created a PowerShell
script to update the WsMan limits suitable for AppInsight for IIS. This can be found at:
https://support.solarwinds.com/?title=Success_Center/Server_%26_Application_Monitor_(SAM)
/AppInsight_for_IIS:_Update_WsMan_limits
Once downloaded, execute the script by right-clicking it and selecting, Run with PowerShell. The following
parameters apply:
You can run this script with the default arguments from the PowerShell console or specify each one.
For example:
& '.\Update WsMan Limits.ps1'
505
Create a WinRM listener
Important: If you received the following error: An HTTPS listener currently exists on port 5986, use the
following steps to configure the listener on an available port by changing "5986" to an available port
number throughout these steps.
1. To configure WinRM on an IIS server, open a command prompt in the Run as Administrator context.
2. Type: winrm create winrm/config/listener?Address=*+Transport=HTTPS @
{Port="5986";CertificateThumbprint="<Thumbprint value of
certificate>";Hostname="<IP Address of Server>_Solarwinds_Zero_
Configuration"} and then press Enter.
506
Find IIS URL settings
By default, AppInsight for IIS uses the following URL for the IIS and WinRM sessions, where ${IP} is the IP
address of the server node being added.
WinRM: https://${IP}:5986/wsman/
Additionally, the value of Hostname must match the CN of the certificate listed in the Certificate
Thumbprint property.
507
508
AppInsight for SQL
SAM offers a detailed view of your SQL databases' performance without the use of agents or templates by
using the AppInsight for SQL embedded application. AppInsight for SQL provides a level of detail and
expert knowledge far beyond what a SQL template can provide, allowing you to monitor virtually every
aspect of your SQL instances and databases.
Like any unassigned application in SAM, AppInsight for SQL is considered a template until it is applied.
Therefore, it is a member of the Application Monitor Templates collection.
Once applied to a node, AppInsight for SQL is considered an application. Like any SAM application,
AppInsight for SQL is comprised of multiple component monitors.
509
Add AppInsight for SQL to a node via discovery
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Add a Node.
2. Fill out the information on the Define Node step, and then click Next.
3. On the Choose Resources step, check the AppInsight for SQL applications you want. When done, click
Submit.
510
Add a named instance
If you have additional pollers and want to use them to poll AppInsight for SQL, ensure you install
the additional poller software on the poller(s) that are used. Not doing this takes you to the List
Resources page and you will not see AppInsight for SQL.
1. Open a command prompt and ping the server, as shown below:
Add a node
You may need to log in with an administrator account to perform this action.
1. Next, add the node to your SolarWinds implementation. The proper permissions are needed. To do
this, take the following steps:
a. On the web console, navigate to Settings > All Settings > Manage Nodes.
b. Click Add Node, then e Enter the IP Address (VIP of the SQL instance gathered earlier.)
c. Select a polling method, then select the polling engine for that node.
Set properties
You can begin editing the properties of the node being added.
1. At the top of the form, change the name to the instance you are going to be monitoring. Additional
information can be changed as desired. Not selecting a name results in the default instance being
monitored.
511
2. Click OK, Add Node.
3. To view your progress, click the Applications tab from the web console
This instance is grayed until the poller has polled this node. Once polled, the color changes.
512
Edit the AppInsight for SQL template
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Check the AppInsight for SQL template in the list and then click Edit.
3. From here, you can edit certain component monitors within the template; including threshold values,
number of records to retrieve, component monitor description, and so on.
4. When done editing, click Submit at the bottom of the screen.
Edit resources
1. From the resource, click Edit in the upper right-hand corner of the resource.
2. Select resources as needed, then click Submit.
513
Navigate the different AppInsight for SQL views
AppInsight for SQL acts like any other application and can therefore be found in the All Applications
resource on the Application Summary view. By default, sub-views are turned on once you navigate to the
AppInsight for SQL Details page.
You may need to log in with an administrator account to perform these actions.
1. On the Web Console, click My Dashboard > Applications > SAM Summary > All Applications resource.
2. Expand the AppInsight for SQL tree by clicking [+].
3. Select a SQL instance to view by clicking it.
From the AppInsight for SQL Details view, click a database in the All Databases resource.
From the AppInsight for SQL Details view, click a performance counter in any resource.
514
Monitor clusters with AppInsight for SQL
1. Connect to the instance that you want monitor using SQL Management Studio.
2. Execute the following query to make sure you have the proper target node and instance name:
SELECT SERVERPROPERTY('ServerName')
3. Determine the IP address of the target node (e.g. “ping P111SQLV23”)
4. Make sure that the node with this address is being monitored by SAM. If it is not, add it.
Note: If the IP address represents a cluster, the node name of the active cluster member populates.
It is recommended that you change the node name to something more easily understood, for
example: “P111SQLV23 (cluster)” during the final step of the Add Node Wizard.
5. Enter the proper information and manually assign the Appinsight for SQL template to the node with
the appropriate IP address.
6. The application should begin polling.
515
Manage the Desktop Notification tool
The Desktop Notification Tool is an application that is installed on an administrator's desktop that can be
used to notify administrators when there is an alert in Orion without the need for a web browser to be
opened to the Orion web page. This tool is available for download through the web based alert manage.
This tool allows you to play a sound as your alert action.
1. Click Start > SolarWinds Orion > Desktop Notification Tool > Desktop Notification Tool.
2. Enter the correct Orion server and credentials. When done, click Connect.
3. From the Preferences screen, select the options you want, and then click Save.
SolarWinds Free Mobile Monitor is a mobile application that allows you to view alerts, acknowledge
alerts, view the status of nodes, and applications from your mobile device. This is a free download
that can be found in your Customer Portal.
Free Mobile Monitor supports the following mobile device operating systems:
516
n Android
n Apple iOS
n Older Blackberry devices)
Mobile Admin is a product that includes all the functionality of Free Mobile Monitor, but
extends that functionality by allowing you to resolve issues from your mobile device. This
download can be found in your Customer Portal. The Administrator's Guide for Mobile Admin
can be found at: Mobile Admin Documentation.
517
Agents
SolarWinds Orion agents
An agent is software that provides a communication channel between the Orion
server and a Windows or Linux computer. Agents are used to provide information
about key devices and applications that you specify. This can be beneficial in the
following situations:
You can monitor servers hosted by cloud-based services such as Amazon EC2,
Rackspace, Microsoft Azure, and other Infrastructure as a Service (IaaS).
After deployment, all communication between the SolarWinds Orion server and the
agent occur over a single fixed port. This communication is fully encrypted using
2048-bit TLS encryption. The agent protocol supports NAT traversal and passing
through proxy servers that require authentication.
Agent requirements
Agent software is free. You remain bound by the limits of the license you own
regardless of how information is polled, either through an agent or another polling
method.
Before you deploy agents to a target computer, review the following system
requirements.
518
Agent requirements
TYPE REQUIREMENTS
The following operating systems are supported for both 32-bit and
64-bit computers:
After the agent is installed, it runs as the Local System account and
does not require administrative permissions to function.
Account If you want to deploy agents from the SolarWinds Orion server, the
permissions following requirements must be met:
519
TYPE REQUIREMENTS
n The account used for remote deployment must have access to
the administrative share on the target computer:
\\<hostname_or_ip>\admin$\temp.
n User Account Control (UAC) must either be disabled on the
target computer, or the built-in Administrator account must be
used.
RESOURCE CONSUMPTION
Less than 1% on average under normal operating conditions (0.24% on
CPU
average)
520
Agent settings
n 135 (DCE/RPC Locator service) Microsoft EPMAP. This port must be open on the
client computer (inbound) for remote deployment.
n 445 Microsoft-DS SMB file sharing. This port must be open on the client
computer (inbound) for remote deployment.
Agent settings
The Agent Settings page provides access to all of the settings and tools needed to
install and manage agents. Additional agent settings can be found in the Windows
Control Panel.
521
n Allow automatic agent updates: Select this option to automatically upgrade the
agent software when updates are available. This process pushes a new version
of the agent to client computers over the agent communication channel. No
extra ports or permissions are needed. Once the agent receives the new
version, it updates itself. This process does not require rebooting.
n XX Hours: Control the length of time the agent displays as being new in the
Manage Agents list.
Server-initiated communication
All communication between your SolarWinds Orion server or additional polling
engine and the agent is initiated by the server, and the agent does not initiate
communication to your SolarWinds Orion server. You must have a direct route from
the server with the agent installed to your SolarWinds Orion server or additional
polling engine. To use this communication method, port 17790 must be open on the
firewall of the remote host to retrieve information from the agent.
522
Agent-initiated communication
Agent-initiated communication
All communication between your Orion server or additional poller and the agent is
initiated by the agent, and your SolarWinds Orion server does not initiate
communication with the agent. You do not need to have a direct route from the
server with the agent installed to your SolarWinds Orion server or additional poller.
To use this communication method, port 17778 must be open on the
SolarWinds Orion server firewall to receive information from the agent.
This communication method is most useful when the agent is installed on a network
separated from your Orion server by one or more NAT devices, and you have no easy
way to connect the two.
523
Windows agent deployment
SolarWinds Orion products supports three methods of deploying an agent to a client
computer running Windows.
n Push the agent software from the Orion Server to one or more client
computers.
n Mass deploy the agent software to multiple computers using a mass
deployment technology, such as Group Policy.
n Manually install the agent on a client computer.
Agents do not work with AppInsight for SQL when the SQL Server being
monitored is in a cluster.
This is the easiest and most common method to deploy an agent to a Windows
computer. For this deployment method to succeed, the Orion server must be able to
communicate with the client computer.
524
Deploy Windows agent software via server push
1. On the Deploy Agent on Network page, enter the IP address or host name of the
Windows computer where you want the agent to be installed, or select nodes
from the list, and then click Next.
This field does not accept ranges. Only add computers that are not
nodes in the system.
When the connection is successful, the agent displays in the agent list on the Manage
Agents page.
525
Connect to a previously installed agent
Select this method to connect to agents that were configured with server-initiated
communication, or if Allow Automatic Agent Registration is not enabled. When you
connect to an agent, you first need to select the communication mode that was
chosen when the agent was installed. If the communication mode is server-initiated
(passive), a shared secret was required during installation. This secret must be
entered again here.
1. On the Add Agent page, enter a name for the Agent.
2. Select the agent communication mode.
3. For Server-initiated communication:
a. Enter the IP address or hostname where the agent is located.
b. Enter the shared secret.
c. Optional: Expand Advanced and adjust the following settings as needed:
a. Change the agent port number. This is the port the agent uses for
listening.
b. Use a proxy. Selecting a proxy and enter the proxy URL.
c. Use proxy authentication, and enter credentials.
4. For Agent-initiated communication, select the agent from the Agent list.
5. Select Allow automatic agent updates to upgrade the agent automatically when
upgrading to new versions of Orion Platform modules that support the agent.
526
Mass deploy a Windows agent
When installation is successful, the agent displays in the agent list on the Manage
Agents page.
Polling engine selection is important. When you click Download .MST, the MST file
created includes the polling engine IP address and other vital information. When you
deploy the agent using the MSI file, along with the MST file on the managed node, the
agent will be installed and pointed to the correct polling engine.
527
5. Select the agent communication mode. This information is included in the
MST file.
n For agent-initiated communication, enter the polling engine you want
the agent to use. You may need to manually enter the polling engine
information if the IP address is different from what the
SolarWinds Orion server reports. This happens when the monitored
host is behind a NAT or proxy device. In these cases, enter the IP
address of the SolarWinds Orion server or the additional polling engine
as it is accessible from the host where the agent will be installed.
a. To use an existing polling engine, select Use Connection Details
from Polling Engine, and then select a polling engine from the list.
b. To manually enter the polling engine IP address, select Enter
Connection Details Manually, and then enter the host name and IP
address. The IP address is required. Use the host name and
IP address of the polling engine that you can access from the
client.
n For server-initiated communications, enter your agent communication
port number. The default port is 17790.
6. Click Download .MSI, and save the file.
7. Click Download .MST, and save the file.
1. Copy the MSI and MST files to a shared network location that is accessible to
the hosts where you want to deploy the agent software.
2. Configure the permissions on the shared location to ensure that all required
users and computers have Read access to the installation files.
3. Locate the container in Active Directory (a site, a domain, or an organizational
unit (OU)) where you want to advertise the application and access the container
properties.
4. Add the modification for the application package. For more information, search
for "Add or remove modifications for an application package" at
technet.microsoft.com.
5. After you complete the setup, the agent is deployed and registered by Orion (if
auto-registration is enabled as defined in the Agent settings page).
When the installation is successful, the agent displays in the agent list on the
Manage Agents page.
528
Deploy with a Gold Master Image
After the software you want to install is packaged in the Windows Installer package
format, you can use MST files to customize the software for your organization, such
as installing only specific features. The modular design of Windows Installer
packages simplifies deployment. When you apply transforms to an MSI file, Windows
Installer can dynamically add or modify data in the installation database to customize
the installation of the application. Additional information on creating MST files can
be found on technet.microsoft.com.
1. Share a folder containing the MST and MSI files with proper permissions.
2. Create a Group Policy object. In Advanced Options, add the Software
installation policy selecting the network path for Agent MSI/MST.
Use a Gold Master Image when you want to maintain a master image that is copied
when a new server is provisioned. This is useful for virtual machines, physical
servers, and cloud instances. Whenever a new server is brought online using this
image, the agent will already be installed.
529
5. Select the agent communication mode. This information is included in the MST
file.
n For agent-initiated communication, enter the polling engine you want
the agent to use. You may need to manually enter the polling engine
information if the IP address is different from what the
SolarWinds Orion server reports. This happens when the monitored
host is behind a NAT or proxy device. In these cases, enter the IP
address of the SolarWinds Orion server or the additional polling engine
as it is accessible from the host where the agent will be installed.
a. To use an existing polling engine, select Use Connection Details
from Polling Engine, and then select a polling engine from the list.
b. To manually enter the polling engine IP address, select Enter
Connection Details Manually, and then enter the host name and IP
address. The IP address is required. Use the host name and
IP address of the polling engine that you can access from the
client.
n For server-initiated communications, enter your agent communication
port number. The default port is 17790.
6. Click Download .ZIP, and save the file.
7. Extract the contents of the ZIP file, and double-click setup.bat.
8. Follow the instructions in the installation wizard.
If you are deploying a server-initiated agent, take the following steps to enable agent
communication with your SolarWinds Orion server.
You can only perform this deployment method if you have successfully configured
Patch Manager to push software in your environment.
530
Deploy a Windows agent with Patch Manager
Record the Latest Version value under the MSI file download. This is
needed when creating a package in Patch Manager.
531
Build the package
3. From the SolarWinds, Inc. Packages action pane, click New Package. This
launches the Patch Manager Package Wizard.
532
Deploy a Windows agent with Patch Manager
4. In the package information screen, enter the following general information for
the package:
n Package Title: SolarWinds Orion Agent (version number) MSI
n Description: SolarWinds Orion Agent
n Classification: Tools
n Vendor: SolarWinds, Inc.
n Product: Orion Agent (This must be entered the first time)
n Severity: None
n Impact: Normal
n Reboot Behavior: Can request reboot
All other fields can be left empty.
533
Add deployment rules
The GUID is detected from the installer. Use the one displayed in your
environment.
7. Select Includes additional files with the package, and click the button to the
right to open the Package Content Editor.
534
Deploy a Windows agent with Patch Manager
8. In the Package Content Editor, click Add Files, and browse to the MST File for
the SolarWinds Orion agent.
9. Click OK to close the Package Content Editor. To confirm that you want to add
these files to the cache, click Yes.
10. Select None for the Binary Language.
11. In the Command Line field, enter: TRASNFORMS=(MST FILE NAME)
Example: TRANSFORMS=SolarWinds_Agent_1.5.0.951.mst
535
18. For the Rule Type, select File Version with Registry Value. Enter the following
values:
a. Registry Key: HKEY_LOCAL_
MACHINE\SOFTWARE\Wow6432Node\SolarWinds\Agent
b. Registry Value: InstallDir
c. Comparison: Equal To.
d. Version: Version number of the agent
19. Click OK to save the rule, and click Next. Review the Summary Page, and enter
notes at the bottom.
20. Click Next to save, and click OK.
When the file packaging and uploading completes, a Package Saved dialog displays.
1. In the SolarWinds, Inc. Packages view in Patch Manager, select the SolarWinds
Orion Agent package that you created.
2. In the SolarWinds Orion Agent action pane, click Publish Packages.
3. Accept the default selections, or choose a specific Windows Server Update
Services (WSUS) server for publication, and then click Next.
4. You are notified when the package publishes.
5. Click Finish to close the Publishing Wizard.
The package for the SolarWinds Orion agent is packaged and published to your WSUS
server.
536
Deploy on Windows Core Servers
If you are installing the agent on a Windows Core Server, you must install the .NET
Framework 4.0. Also install the latest Windows service pack and critical updates.
n Start WoW64.
n Start the .NET 2.0 layer.
n Start the .NET 2.0 layer for WoW64.
n Download and install the .NET framework from www.microsoft.com.
Once the .NET Framework is installed, you may need to reboot the host server. The
agent can then be deployed to the host server and operate normally.
Agents can be deployed in the cloud for use with Amazon Web Services, Microsoft
Azure, and other third-party cloud infrastructure services.
You can manually deploy agents to a virtual machine using Remote Desktop
Connection.
537
Install through the command prompt
You can perform the following steps through the API or AWS command
line interface.
10. Create an instance, and paste your PowerShell script under Advanced Details in
the User Data text box. Select the As Text option.
538
Deploy Windows agents in the cloud
11. For instances that are already created, take the following steps:
a. Stop the instance where you want to deploy the agent
b. Right-click the instance and click Instance Settings > View/Change User
Data.
c. Paste you PowerShell script in the text box as Plain Text.
539
8. Add your PowerShell script to virtual machines manually on the last step of the
Create a Virtual Machine wizard in the Azure management portal.
This step can also be accomplished via the API or AWS command line
interface.
n Add Agent: Takes you to the Add Agent page, where you can deploy the agent
on a network, or connect to a previously installed agent.
n Edit Settings: Takes you to the Edit Agent Settings page, where you can adjust
the agent name and automatic updating.
n Delete: Deleting an agent from within this toolbar or the Manage Nodes page
provides you the option to remotely uninstall the agent.
540
Manage Agents toolbar options
541
Manage Agents table columns
542
Edit agent settings
543
n Troubleshooting:
n Log level: the amount of detail saved to the log.
n Diagnostics: click Collect new diagnostics, and then Download to save to
your local disk. Send the zip file to our support team if requested.
If nodes are using different polling methods, you may want to keep track of the
polling method of each node to troubleshoot issues more easily. There are several
methods you can use to identify the polling method of nodes:
544
View the status of agent plug-ins
3. If not already visible, add the Polling Method field by clicking >> in the upper-
right of the table.
STATUS MEANING
The plug-
The plug-in is installed, working correctly, and communicating with no
in is
problems.
installed
545
If you think a plug-in should be available and cannot find it in the list, you may need
to check your purchased products or manually update your agent. New plug-ins and
updates to existing plug-ins are installed when an agent is updated. It may take a few
minutes before the status changes.
The Agent Shared Secret is provided for security. When you install the
agent, you must set a shared secret. When the SolarWinds Orion server
connects to the agent, it verifies the secret to connect.
You can connect to agents that you installed previously or modify the assigned
polling engine of the agent. The steps are different depending on the agent
communication mode. You should confirm the agent communication mode before
connecting.
546
Change agent communication modes
When you want to change how the agent communicates back to the SolarWinds Orion
server, you must uninstall and redeploy the agent with the new communication
method. Ensure that you loose as little data as possible, and prevent alerts or node
down notifications, by changing the polling method before you remove the agent.
547
4. Under Polling Method, click Windows Servers: WMI and ICMP.
5. Enter your WMI credentials, and click Submit.
1. On the computer with the deployed agent, edit the following configuration file
using a text editor:
548
Agent polling method
n If you installed the agent manually, you can change the port number
during installation through the wizard in the web console.
n If you deployed the agent from the server, the port number is set
automatically.
n If you used the MST file for mass deployment, you must download a new
MST file from the server after you change the port number.
When the Agent Polling Method is selected, an agent is deployed to the node and
installed using the credential you selected. After the agent is installed, it operates
under a local account.
549
Check nodes polling with agents for changes
Agent discovery has an option to keep nodes updated that use agents. Select this
option so the Orion server can find new volumes, interfaces, and other objects on
nodes that are polled by an agent.
While normal discovery finds new nodes and adds them to the SolarWinds Orion
server, this is not true for nodes using the agent. Agent discovery is an extension to
the standard discovery process.
NAME DESCRIPTION
The number of messages sent to the Agent Management
Messages Sent
Service.
Exchange Sent The number of times the Exchange Send method was called.
550
SolarWinds: Agent Management Service
NAME DESCRIPTION
Messages Sent to Agent
The number of messages sent to the agent.
Count
Incoming Timed Out The number of incoming messages that timed out
Messages Count before being processed by the recipient.
Outgoing Timed Out The number of outgoing messages that timed out
Messages Count before they were sent to the target agent.
Passive Agents
The number of passive agents disconnected.
Disconnected
551
NAME DESCRIPTION
Incoming Messages The number of incoming messages processed per
Processed per Second second.
Incoming SignalR
The number of messages received from SignalR.
Messages
Outgoing SignalR
The number of messages passed to SignalR to send.
Messages
For more information, search for "Add the Certificates Snap-in to an MMC" at
technet.microsoft.com.
552
Custom properties
Custom properties
Custom properties
Every object you monitor includes a list of default properties used to describe the
devices, such as IP address, host name, or MAC address. You can also create custom
properties and use them to create special alerts, reports, views, and groups.
Custom properties are user-defined fields, such as country, building, asset tag, or
serial number, that you can associate with monitored network objects.
When a custom property is defined, you can import values for the property from a
text- or comma-delimited file.
To apply a property to only a few objects, go to the Edit view in the Orion Web
Console.
You may also create external records by exporting custom properties from selected
objects as a spreadsheet.
When you create, edit or remove a custom property, an event is logged. These
events are audited, and you can display them in Audit Events resources.
Custom properties help you add custom labels to monitored objects, group objects
based on the property or alert on objects with a certain value for the property.
Depending on the selected object type, some options are not available.
553
1. Click Settings > All Settings in the menu bar.
2. In the Node & Group Management grouping, click Manage Custom Properties.
3. Click Add Custom Property.
4. Select the object type for the property, and click Next.
To limit the string length, click Edit, and provide the maximum number of
characters.
c. Create a drop-down menu with specific values for the property by
selecting Restrict values, and adding the values.
d. If you want to limit how the custom property for nodes should be used,
clear boxes in the Usage section.
554
Create a custom property
6. Select objects for which you want to define the custom property.
a. Click Select <Objects>, and locate, and select the objects in the Available
<Objects> pane.
b. Click Add, and then click Select <Objects>.
7. Enter or select a default value for the property.
To add a value for properties with restricted values, select Add New
Value from the drop-down menu, and enter the new value.
8. To apply the selected property to a different group of objects, click Add More,
select the objects, and click Submit.
You have created a custom property and provided its value for the selected objects.
Now, you can specify the property value in the object properties. For example, for
node properties, click Settings > Manage Nodes, select the object, and click Edit
Properties.
555
You can now use the custom property for sorting objects of the type in Group By lists.
If you have a spreadsheet listing custom property values, such as asset tags of all
your network nodes, you can make this information available for reporting and
publication in the Orion Web Console.
556
Import custom property values
Your data must be formatted as a table, and at least one column title should
match an existing object property such as IP Address.
n Select Imports To, and select <No Match Found, Ignore> for any
spreadsheet column you do not want to import.
n Click Create This Custom Property Now to open the Add Custom
Property in a new browser tab if you need to create a custom property
for this spreadsheet column.
8. Click Import.
When you view the values of the object type, the values of the custom property you
selected are populated.
557
Export custom property data
If you want to keep records of custom properties for selected monitored nodes, you
can export them as a spreadsheet. For example, you can create a single spreadsheet
that lists the asset tags of all your network nodes.
You can only select custom properties for a single object type.
You can change the value of a custom property from the Manage Custom Properties
page or bulk edit the values of a custom property assigned to objects.
When you are entering a large amount of data, it can be easier to import the values
from a spreadsheet.
558
Filter objects when assigning custom properties
5. To add or change a value for a property, enter the value into the field.
6. To add the same custom property value for multiple objects, select the objects,
and click Edit Multiple Values. Select the property, enter the value, and click
Save Changes.
7. When you have added or edited the values, click Save Changes.
You can limit objects displayed in the Custom Property Editor to find the objects you
want to edit.
The table will only display objects matching the filter options. The condition is added
above the Group by section of the Custom Property Editor.
559
To remove the filter, click the trash icon next to the filter.
Alerting
Use alerts to monitor your environment
An alert is an automated notification that a network event has occurred, such as a
server becoming unresponsive. The network event that triggers an alert is
determined by conditions you set up when you configure your alert. You can
schedule alerts to monitor your network during a specific time period, and create
alerts that notify different people based on how long the alert has been triggered.
The types of events for which you can create alerts vary, depending on the Orion
Platform products you have installed. For example, you can create an alert to notify
you if a node in a specific location goes down or if the network response time is too
slow when you have NPM. If you have installed SAM, you can receive alerts about
application response times or when your Exchange mailbox database is almost full.
You can create alerts for any monitored object. You can alert against volumes and
nodes with most Orion Platform products.
Use the following topics to get started if you have never used Orion Platform
products:
560
Alert preconfiguration tasks
You can also view our Alert Lab on thwack for community-based alert information.
Alert actions that require set up before creating or configuring alerts include:
The information you provide in the default email action is used to populate the Send
an Email/Page action. You can still customize individual email actions if you configure
the default email action.
561
Best practices and tips for alerting
Use these best practices and tips to help you configure and test your alerts.
SolarWinds recommends using the alerts that are included when you install
the product as templates for your new alerts.
Find an alert that is similar to one you want to create and then click Duplicate
& Edit in the menu bar. Fields are pre-populated so you can skip to specific
parts of the Alert Wizard where there is data you want to change.
If there are out-of-the-box alerts that match your monitoring needs, enable
them in your environment. You can customize the alert actions for those alerts.
If you want to modify the conditions, use the alert as a template.
During your initial evaluation and testing, send alerts to a few people instead of
to a large distribution list. This can prevent overloading your email server while
you fine-tune your alerts.
To reduce the number of alerts sent out, consider which devices are most
important. For example, you may want to receive alerts only for mission-critical
interfaces instead of every interface on a device.
Establish dependencies
Use the Alert Manager to create, edit, delete, enable, or disable alerts. You can access
the Alert Manager in one of four ways:
562
Create new alerts to monitor your environment
1. Enter the alert properties, which includes who can view the alert, severity, and
how frequently the alert conditions are evaluated.
2. Define the conditions must exist to trigger the alert.
3. Define what event occurs to reset the alert.
4. Schedule when you want the alert to monitor your environment.
5. Define what happens when an alert is triggered.
6. Define what happens when the alert is reset.
7. Review your alert, including the number of alerts that will be triggered based
on the conditions you defined.
You can skip to different steps if you clicked Duplicate & Edit or if you are
editing a saved alert.
Once you have created an alert, it is added to the list of available alerts in the Alert
Manager. When the alert is enabled, it immediately monitors your environment for
the conditions necessary to trigger it.
563
Set alert properties
After creating a new alert, use the Alert Properties to describe the alert, including
which users can view the alert.
This is a required field. The name is displayed in the Alert Manager and can be
used to sort your alerts. If you intend to create a large number of alerts,
consider a naming convention that allows you to quickly scan through them.
SolarWinds recommends a name that describes the condition and most visible
alert action. For example, you can use "Email NetAdmins when router goes
down" as the name of an alert.
Describe the alert. This is displayed on the Manage Alerts page, so important
information should be near the front.
Enabled (On/Off)
Choose to evaluate the alert immediately after it is created and saved. The alert
is enabled. If you are in the process of refining your alert, you may want to
disable this alert until it is ready for use.
Evaluation Frequency
Set how frequently you want to evaluate the conditions. If you choose to alert
on an event, such as a changed IP address, the condition is not evaluated by
frequency, but by when the change is reported based on the polling interval.
Severity of Alert
Control how the alert in the Active Alerts resource looks, and use the severity to
group or filter alerts more easily.
564
Create new alerts to monitor your environment
Use custom properties to organize your alerts. For example, you can create a
"Responsible Team" custom property and use it to help audit who receives
specific alerts.
You must create a custom property for alerts before you can use it in an alert.
Restrict who can view the alerts. For example, managed service providers can
restrict alerts to their specific customers. Create a new alert limitation by
editing or creating a user account.
The trigger condition is the most complex step in creating an alert. Before you begin,
you may want to revisit the Best practices and tips for alerting. To see an example of
completed trigger conditions, see the Alert me when a server goes down topic.
Trigger conditions are built using child conditions that are evaluated in order. Child
conditions are represented as a line item under the Actual Trigger Condition. You
can have multiple trigger condition blocks with multiple child conditions.
Filter your environment to only display the objects you want to monitor in The
scope of alert. Use the Show List link to view all of the objects that the alert
monitors.
565
1. Choose what objects you want to monitor in the I want to alert on field.
2. Establish how much of your environment you want to monitor in The scope of
alert.
You can monitor all objects in your environment or filter your environment to a
specific set of objects.
3. Create your trigger condition.
a. Choose if the child conditions must be true or false to trigger the alert.
n All child conditions must be satisfied (AND) - Every child condition
must be met
n At least one child condition must be satisfied (OR) - At least one
child condition must be true
n All child conditions must NOT be satisfied - Every child condition
must be false
n At least one child condition must NOT be satisfied - At least one
child condition must be false
b. Click the + sign to add child conditions.
n Add Single Value Comparison (Recommended) - The child
condition evaluates a single field, like Status
n Add Double Value Comparison - The child condition evaluates two
conditions, such as Status and OS
n Add And/Or block - Adds a sub condition block
Use the X at the end of each child condition to delete it, or use the
drop-down menu at the top of the block to delete the entire
condition.
566
Create new alerts to monitor your environment
c. Select the object you want the child condition to evaluate, and then select
which field you want to evaluate. In the example screenshot, the object is
"Node" and the field is "Status".
d. Select how you want to compare the polled value of the field to the
value entered here, and then enter the value. In the example screenshot,
the comparison is "is equal to" and the value is "Down".
e. To use more complex conditions, such as evaluating when an
application on a specific server is down and a different application on
another server is down, enable complex conditions under Advanced
options.
See Building Complex Conditions for more information, or visit thwack,
SolarWinds' community website, for support from other users.
f. Choose how long the condition must exist before an alert is triggered.
This prevents receiving alerts when the alert condition, such as high CPU
utilization, occurs briefly or only once during a certain time period.
n Send an alert immediately when the condition is met by clearing
any selection for Condition must exist for more than.
n Wait before sending an alert by selecting Condition must exist for
more than, and entering how long the condition must exist. This
option prevents multiple alerts firing if the condition is temporary.
If you have successfully created an alert condition, you can move to the next step in
the alert wizard. The Summary step evaluates the conditions against your
environment and returns how many objects will trigger the alert.
Use the reset condition to define what must occur to remove an alert instance from
the active alerts list. For example, the "Email me when a Node goes down" alert
automatically resets when the node comes back up. You can use the built-in reset
conditions or create your own.
When reset conditions are met, the alert is removed from Active Alerts. You can also
add actions that occur when the reset conditions are met.
567
For example, you can create an alert that triggers when nodes in your lab go down. If
node 192.168.4.32 goes down, the alert fires for that specific instance of the
trigger condition and any escalation levels you create continue until you reset the
alert. After the alert is reset, all trigger actions stop and a new alert fires the next
time node 192.168.4.32 goes down. If you have created reset actions, the reset
actions fire.
You can use the Condition must exist for more than option in the trigger
conditions in conjunction with this reset condition. Trigger conditions that
involve volatile components, such as high CPU utilization, can trigger
excessively with this reset condition.
n Reset this alert automatically after
Select to reset an alert after a set amount of time has passed. If this interval is
less than the amount of time you wait for different escalation levels, the
escalation levels that occur after this interval do not fire. This reset condition is
especially useful to remove event-based alerts from Active Alerts.
For example, if the trigger conditions still exists after 48 hours, you can use this
to trigger your alert actions again. The alert is reset and triggers as soon as the
trigger condition is detected, which is as soon as the objects are polled for this
example.
n No reset condition - Trigger this alert each time the trigger condition is met
The alert fires each time the trigger conditions are met.
For example, when the alert for node 192.168.4.32 going down fires, a new
alert for 192.168.4.32 fires every time the node is down when it is polled.
n No reset action
The alert is active and is never reset. To re-trigger the alert, the alert must be
manually cleared from the Active Alerts view.
568
Create new alerts to monitor your environment
You can configure when an alert monitors your environment. By default, alerts
monitor your network for changes all the time. Schedule when you want to monitor
your network for the trigger conditions you created for the alert.
You can create multiple schedules that control when an alert is enabled or disabled.
For example, you can schedule the alert to monitor your network during off hours,
and disable the alert during your maintenance windows.
569
3. Enter the following information:
n Schedule Name
This is not required, but may help you organize or troubleshoot your
schedules. If you do not enter a name, a name is automatically generated
from the time period.
n Enable or Disable alert during following time period
If you choose to disable the alert, it is enabled all other times unless
otherwise scheduled.
n Frequency
Choose when to monitor on a high level, such as daily, weekly, or monthly.
n Enable or Disable every
These options change based on the frequency.
n If you selected Daily:
You can choose to enable or disable the alert every few days, up to
every 31 days. You can also select business days. For example, you
may want to disable network or disk activity alerts if you run daily,
off-site backups of your critical data.
n If you selected Weekly:
Choose which days the alert is enabled or disabled. You may want
to disable alerts during a weekly maintenance window.
n If you selected Monthly:
Choose which months the alert is enabled or disabled. This option
is useful when you have quarterly or monthly maintenance
windows.
Choose either a specific date, such as June 22nd, or a day, such as
Thursday.
n Starting on
Choose when to begin the schedule.
n Right now - Start the schedule immediately.
n Specific Date - Select a time and day to begin the schedule.
n Ending on
Choose an end date for the schedule, if necessary.
4. Click Add Schedule to create the schedule.
When you add a schedule to an alert, the alert only monitors during the time period
you have scheduled, or does not monitor during that time. Alert actions can also have
schedules, so not all alert actions may occur during the scheduled period.
570
Create new alerts to monitor your environment
Choose actions that occur whenever the trigger conditions are met. You can also set
up escalations levels so that different actions occur if the alert has not been
acknowledged quickly enough.
By default, what you enter into the Message displayed when this alert field is
displayed in the All Active Alerts resource.
You can create a new action or use an action that you have already created. When
you reuse an action, you are also reusing all of its configurations, including its
schedule and execution settings.
If you are alerting others through email, SolarWinds recommends that you
notify a small number of users while you fine tune your alerts.
571
4. Enter the necessary information for the action.
Each action requires different information. Select from the list of Alert Trigger
Actions for more information per action.
Some actions require extra configuration steps, specific information, or special
software. See Alert preconfiguration tasks.
Each action has the following sections:
n Name of action - This is not required, but makes it easier to organize
and find your actions in the Action Manager.
n Time of Day - You can choose different actions to occur at different
times of the day or month. For example, if you want to send a page, you
might send it to a different person on weekends or holidays rather than
during the week.
n Execution settings - You can select both options, neither option, or a
single option.
n Do not execute this action if the alert has been acknowledged
already (Recommended)
n Repeat this action every X minutes until the alert is acknowledged
5. Click Add Action to save it to the list of actions in the alert.
If you use a preexisting action, any configuration change you make to the
action, including schedules, is used in every alert the action is assigned.
Escalation Level 1 contains all initial actions that you want to occur when the trigger
conditions are met and the alert activates.
572
Add a preexisting action to the alert
Escalation Levels 2 and above include all actions you want to occur if no one
acknowledged the alert during the previous escalation levels.
For example, if an alert for a critical server activates and all of the recipient or first-
level responders are out for training and do not acknowledge the alert, then the
actions fire in the second escalation level. These actions may include emailing
managers or other backup staff.
You can copy all of the actions as Reset Actions. This lets you quickly craft
actions to indicate that the issue has been acknowledged or resolved. Click
Copy Actions to Reset Actions Tab.
When an alert is triggered, the actions will be performed in the order that they are
displayed on the list. You can test each action to ensure the action does what you
expect it to do.
Use reset actions to perform specific tasks when an alert is no longer active, such as
writing to the log that the issue has been acknowledged. Reset actions are usually
used to notify others that the situation has been resolved or to write the resolution to
a log file.
573
4. Enter the necessary information for the action.
Each action requires different information. Select from the list of Alert Actions
for more information per action.
Some actions require extra configuration steps, specific information, or special
software. See Preconfiguration Tasks.
Each action has the following sections:
n Name of action - This is not required, but can make it easier to organize
and find your actions in the Action Manager.
n Time of Day - You can choose different actions to occur at different
times of the day or month. For example, if you want to send a page, you
might send it to a different person on weekends or holidays than during
the week.
5. Click Add Action to save it to the list of reset actions in the alert.
To perform the same actions as when the alert was triggered, click Copy Actions
From Trigger Actions Tab. Use the copied trigger actions as a base and modify them
to reflect that the alert is no longer active.
When an alert is reset, the actions will be performed in the order that they are listed.
You can test each action to ensure the action does what you expect it to do.
The Summary tab allows you to check your alert definition before you save any
changes.
Before you click Submit, review the information box above it. This box lists the
number of objects that will trigger the alert immediately based on your
current trigger condition.
You can integrate your alerts with other SolarWinds' products, such as AlertCentral or
Web Help Desk, by expanding Alert Integration.
574
Commonly Created Alerts
Once you have created an alert, it is added to the list of available alerts in the Alert
Manager. When the alert is enabled, it immediately monitors your environment for
the conditions necessary to trigger it.
The following is a list of frequently created alerts. The topics walk you through the
easiest method to create the alert and include tips on how to build more complex
alerts.
Use the following procedure to create an alert that writes to a log and sends an email
when a Windows server goes down.
1. Search for "Email me when a Node goes down" in the Alert Manager.
2. Select the check box next to the alert, and then click Duplicate & Edit.
3. Enter a name for the alert, such as "Notify me when Windows 2008 servers go
down".
4. Enable the alert, and then click Trigger Condition or Next.
5. In The scope of alert, select Only following set of objects.
6. Select Node Machine Type is equal to Windows 2008 Server as the
child condition.
575
7. The actual trigger condition should be Node Status is equal to Down.
Select and enter a value for Condition must exist for more than to
prevent being alerted when a node enters the down state frequently
within a set amount of time. This prevents you from receiving alerts until
the node has been in the down state for longer than the time you have
selected.
8. Click Reset Condition. The default action should be to reset the alert when the
node is up.
9. Click Trigger Actions, and then click Add Action.
10. Select Log the Alert to a file, and then click Configure Action.
a. Enter the location of the log. For example, enter
C:\ExampleAlertLog.txt in the Alert Log Filename Field.
b. In the Message text box, type Node ${N=SwisEntity;M=Caption}
is currently down.
c. Click Add Action.
11. Click Add Escalation Level, and enter 5 minutes to wait for 5 minutes before
escalating to the next level.
12. Click Add Action in Escalation Level 2, and select Send an Email/Page. Click
Configure Action.
a. Enter your email as the recipient.
b. Add a message.
c. Enter your SMTP server information if you have not already done so.
You can enter a default SMTP server that is used for all your email
in the Configure Default Send Email Action setting.
576
Commonly Created Alerts
15. Click Edit next to your email action, and modify your message. You can also
delete the email if you do not want to know if the situation has been resolved.
16. Click Summary to see if any object will trigger the alert, and then click Submit.
Once you have created the alert, it is added to the list of available alerts in the Alert
Manager. You can test and view the results of each of your alert actions. See Testing
Alerts for more information.
With alerting, Orion Platform products give you the ability to immediately discover
whenever any device on your network is experiencing a problem.
The procedures in the topics below create an alert that uses a custom location
property to alert you to a node failure on your monitored network:
Alerting on Metrics
The following example creates multiple alerts using the NodeLocation custom
property. An alert triggers when a node goes down. Upon triggering, the alert will
write to a local log file, send a syslog message, and send an SNMP trap.
1. Click Alerts & Activity > Alerts in the menu bar, and then click Manage Alerts.
2. Select the check box next to Node is down, and then click the Duplicate & Edit
button.
3. Click Trigger Condition, and add a child condition. A child condition should
already exist for a node being down.
577
4. Select the node object, and choose NodeLocation in the field drop-down menu.
Enter a comparison and value.
5. Click the Trigger Actions, and then click Add Action.
6. Select Log the Alert to a file, and then click Configure Action.
a. Enter the log filename in the Alert Log Filename field.
b. In the Message text box, type the following:
Node ${N=SwisEntity;M=Caption} is currently down.
c. Click Add Action.
7. Click Add Action, and select Send a Syslog Message. Click Configure Action.
a. Type 127.0.0.1 as the Hostname or IP Address of the Syslog Server,
and then type the following in the Message field:
Node ${N=SwisEntity;M=Caption} is currently down.
b. Click Add Action.
8. Click Add Action, and select Send SNMP Trap. Click Configure Action.
a. Type 127.0.0.1 as the SNMP Trap Destination, and then type the
following in the Alert Message field:
Node ${N=SwisEntity;M=Caption} is currently down.
b. Click Next.
c. Click Add Action.
9. Click Summary to see if any objects will trigger the alert, and click Submit.
After you have created the alert, it is added to the list of available alerts in the Alert
Manager. You can test and view the results of each of your alert actions.
n You can view results of your Syslog message action in the Web Console or
through the Syslog Viewer on your SolarWinds Orion server.
n To view the results of your SNMP Trap action, click Start > All Programs >
SolarWinds Orion > Syslog and SNMP Traps > Trap Viewer.
View active triggered alerts through Alerts & Activity > Alerts in the menu bar. Click
each alert to view the details, which includes a historic count of how frequently the
object triggers the alert and other objects that are experiencing the same set of
conditions that triggered the alert you are viewing.
You can also add the All Active Alerts resource to any view.
578
Remove alerts from the Active Alerts list
When an alert has triggered and becomes active, you can then acknowledge it. After
an alert is acknowledged, alert actions in higher escalation levels are halted and the
time it was acknowledged and the account that acknowledged it is recorded. You can
also add notes that other users can read.
You must enable the Allow Account to Clear Events privilege to acknowledge
alerts. For more information about access privileges for Orion Web Console
users, see Define what users can access and do.
Tip: Depending on how you configure the email, you can acknowledge an alert
directly from an email notification.
You can hide acknowledged alerts by clicking More, and then selecting Hide
Acknowledged Alerts.
You do not have to actually experience a device failure to confirm that your alerts are
working. The trigger condition is automatically evaluated and trigger and reset
actions can be tested individually.
Alert conditions are automatically evaluated on the Summary tab. Scroll to the
bottom of the page and view the information box above the Submit button.
When you simulate actions, the action will be performed regardless of whether the
trigger condition is true. If the action sends a message to a recipient, you should
reduce the recipient list to yourself and a small number of team members until you
are confident the alert is ready to be enabled in your production environment.
579
The Send Email/Page, Play a Sound, and Text to Speech Output actions do not
have to fire. You can view what the message will look like when the trigger or
reset action fires without performing the action.
You can also test actions independent of the trigger or reset conditions by using the
Action Manager.
After the alert test completes, you can view the results of your alert actions.
Use the Alert Manager to bulk edit multiple alerts. You can enable or disable multiple
alerts or add pre-configured actions.
580
Build complex conditions
Assign actions that you have already configured to alerts. You can assign multiple
actions to multiple alerts. Actions are categorized into trigger and reset actions based
on how the action was created in the Alert Wizard.
SolarWinds does not provide generic actions due to the differences in intent behind
trigger and reset actions. For example, a trigger action to send an email is usually a
notification that an event happened, while the associated reset action is usually a
notification that the event has been resolved.
Export an alert to save the alert definition as an XML file on your local computer.
Alerts are exported to XML and can only be imported from XML. You can send this file
to other coworkers or share it in the SolarWinds thwack community.
Before you share an alert, check the exported file for confidential information,
such as SMTP server credentials, and delete before making it public. Also
review your company policy on sharing this type of file.
Complex conditions are generally enabled by users who are comfortable with
building normal trigger conditions, or who have trialed alerts using the normal
trigger conditions and require more control over the trigger conditions to better
refine the environmental conditions that trigger an alert.
Do not use complex conditions until you have tested the trigger conditions
individually. Creating an alert with complex conditions without testing it may
prevent you from receiving important alerts.
581
n Wait for multiple objects to meet the trigger condition before alerting
n Evaluate multiple condition blocks
n Evaluate multiple object types
With complex conditions enabled, you can choose to trigger alerts only when multiple
objects meet the trigger condition.
After you have enabled complex conditions, the following option is available in your
trigger condition:
This setting then combines all alerts that would be sent for each object into a single
alert.
Do not use this setting until you are confident that the trigger condition is
correct. This setting can prevent important alerts from triggering.
For example, if you were monitoring computers used in a high availability cluster, you
may only want to be alerted if more than half the cluster is down at the same time.
You can use complex conditions to evaluate multiple condition blocks, or sections,
independently. For example, you may want to create an alert when an application is
down and when your fail-over server is active for more than an hour.
582
Manage alert actions
3. Select And then after from the drop-down menu between the two condition
sections.
4. Choose how long to wait before evaluating the next section.
5. Create the next condition block.
The condition blocks are evaluated at the same time. If they are all true based on the
conditions, the alert triggers. For example, condition A, B, and C must be true in order
for the alert to trigger.
Condition blocks are evaluated using variations of AND, so the trigger condition in
each section must be met.
A condition block can be evaluated at a different time than other condition blocks.
For example, if you want to be alerted if the backup system is active for more than an
hour, you can choose to wait an hour after the primary condition block, where the
application going down is the trigger condition, before evaluating whether the
backup system is still active.
To evaluate multiple object types, you should use complex conditions. Complex
conditions can be used to alert on different object types within the same alert. For
example, you can create an alert to notify you when IIS is down and the free space on
the volume is less than 30 GB.
You can edit, test, enable, disable, and delete alert actions from the Action Manager.
583
Mostly for bulk actions and assigning previously created actions to alerts. View meta
data about the action to help troubleshoot alert actions from a single area instead of
trying to find the action in an alert.
You can use actions that you have already configured in multiple alerts. For example,
if you have configured an action to email emergency response teams, you can assign
this action to multiple alerts. When you assign an alert, it is added to the highest
escalation level.
Use the On/Off toggle or select an alert and click Enable/Disable to enable or disable
alerts.
584
Available Alert Actions
Custom properties are additional fields, such as country, building, asset tag, or serial
number, that you can define and store in your SolarWinds Orion database. After
properties are added, you can view or filter using them.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Change Custom Property option, and then click Configure Action.
3. Under Custom Property Settings, select the custom property and enter the
value you want to change it to.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
585
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the value of the custom property you selected changes.
This alert management action is only available if the integration with ServiceNow® is
enabled.
If the property you want is not displayed in the Incident Detail section,
click Select Properties at the bottom of the section, and select the
property from the list.
5. Under State Management, define the status of the incident when the incident
is reset, reopened, acknowledged, and closed. You can also specify notes to be
added to the incident.
6. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
7. Select how frequently this action occurs for each triggered alert in Execution
Settings.
8. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
an incident will be created or updated in the specified ServiceNow instance.
586
Available Alert Actions
When you use this alert action, we recommend that you only use it on the
trigger tab. It is also recommended that you only use one ServiceNow action
per alert.
To deactivate the integrated behavior, remove the alert action from the alert
definition.
You can specify one alert action for one ServiceNow instance. To create an
incident in another ServiceNow instance, specify another alert action and use
a different ServiceNow instance.
This action forwards alerts to a paging or SMS service. You must download and install
NotePager Pro from Notepage.net to your SolarWinds Orion server to use this action.
For instructions on configuring this action, see the NotePage Technical Support page
at http://www.notepage.net/solar-winds/technicalsupport.htm and SolarWinds
Network Performance Monitor Integration at www.notepage.net.
Send a web page, including content of resources available in the Orion Web Console,
to others.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Email a Web Page option, then click Configure Action.
3. Enter the Recipients.
4. Enter the Subject and Message of your alert trigger email/page.
n For the Optional Web Server Authentication section, select User
currently logged in, Another user, or No user defined.
Use variables to make the message dynamic.
n You can create a dynamic URL to send information about the object that
triggered the alert.
587
5. Enter your SMTP server information.
6. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
7. Select how frequently this action occurs for each triggered alert in Execution
Settings.
8. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
an email is sent to the recipients.
Use variables to create a URL that changes based on the object that triggers the alert.
Click Insert Variable and search for URL to find the all of the variables you can use to
create the dynamic URL.
For example, enter ${N=SwisEntity;M=DetailsUrl} in the URL field to email a link to the
Details view of the object that triggered the alert. When the email is sent, the variable
resolves to a valid URL such as
http://myserver/Orion/View.aspx?NetObject=N:3 and the email contains
the content of the Details view in the body.
There are several circumstances where you may want to execute a program when a
specific network event occurs. For example, you may want to run a custom script to
reboot your SQL servers.
External programs selected for this action must be executable using a batch file
called from the command line. Programs executed this way run in the background.
However, you can set the SolarWinds Alerting Engine Service to Interact with Desktop.
SolarWinds recommends that scripts and batch files be placed on the root of
c:\ to simplify the path for the batch file.
588
Available Alert Actions
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Execute an External Program option, then click Configure Action.
3. Under Execute an External Program settings:
a. Enter the Network path to external program in the field provided.
For example: Use c:\test.bat, where c:\ is the disk on your main
poller and test.bat is your external program to be executed.
b. Select either Define User or No User Defined for Optional Windows
Authentication
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the external program runs.
In some situations, you may want to execute a Visual Basic (VB) script when a network
event occurs to perform a specific action.
SolarWinds recommends that scripts and batch files be placed on the root of
c:\ to simplify the path for the batch file.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Execute an External VB Script option, then click Configure Action.
589
3. Under Execute an External VB Script settings:
a. Select a VB Script Interpreter from the drop down list.
b. Enter the Network path to the external VB Script in the field provided.
For example: Use c:\test.vbs, where c:\ is the disk on your main
Orion poller and test.vbs is your external VB Script to be executed.
c. Select either Define User or No User Defined for Optional Windows
Authentication
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the VB script runs.
SolarWinds can be configured to log alerts to a designated file which can be viewed
at a later time.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Log the Alert to a File option, then click Configure Action.
3. Under Log to File Settings:
a. Enter the log filename in the Alert Log Filename field.
b. Enter a maximum log file size in MB (0 = unlimited).
c. Enter the Message of your alert trigger in the field provided.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
590
Available Alert Actions
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the alert is logged to the file with the message you created.
Record when an alert is triggered to the NetPerfMon (NPM) event log on your
SolarWinds Orion server or on a remote server for later investigation.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Log the Alert to the NetPerfMon Event Log from the options, and then
click Configure Action
3. Under Log the Alert to the NetPerfMon Event Log settings, enter the text you
want written to the file.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
This is often used to prevent an action from occurring during specific windows.
5. Expand Execution Settings to select when the action occurs.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the alert is logged to the NPM event log with the message you created.
If a virtual machine is experiencing performance issues, you can have an alert trigger
a specified allocation of resources. This alert management action is available if the
integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
591
2. Select Manage VM - Change CPU/Memory Resources, and click Configure
Action.
3. Enter a name for the action.
4. Under Select Virtual Machine, specify the virtual machine on which you want to
adjust the number of CPUs, the memory capacity, or both.
a. To change the resource allocation of the virtual machine that triggered
the alert, click Execute this action.
This option is only available if the alert is built to trigger for virtual
machines.
If the option is not selected, the action will be performed live on the
virtual machine.
6. Under Specify New Resources, specify whether you want to add more resources
to the virtual machine, or replace the existing resources with new resources,
and then specify the parameters of the new resource or resources.
a. Select Number of processors, and specify the number of processors to
allocate.
b. Select Memory, and specify the memory capacity to allocate.
7. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
8. Select how frequently this action occurs for each triggered alert in Execution
Settings.
9. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified CPU and memory resources will be allocated to the virtual machine.
592
Available Alert Actions
If a virtual machine is experiencing resource issues, you can have an alert trigger a
virtual machine snapshot to be deleted. This alert management action is only
available if the integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Delete Snapshot, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine from which you want
to delete a snapshot.
a. To delete a snapshot of the virtual machine that triggered the alert, click
Execute this action.
This option is only available if the alert is built to trigger for virtual
machines.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the snapshot of the specified virtual machine will be deleted.
If a virtual machine is experiencing issues, you can have an alert trigger the virtual
machine to be moved to a different host. This alert management action is only
available if the integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Move to a Different Host, and click Configure Action.
593
3. Under Select Virtual Machine, specify the virtual machine that you want to
move.
a. To move the virtual machine that triggered the alert, click Execute this
action.
This option is only available if the alert is built to trigger for virtual
machines.
If the option is not selected, the action will be performed live on the
virtual machine.
5. Under Select Target Host, search for the host where you want to move the
selected virtual machine.
6. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
This is often used to prevent an action from occurring during specific windows.
7. Select how frequently this action occurs for each triggered alert in Execution
Settings.
8. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine will be moved to a different host.
594
Available Alert Actions
If a virtual machine is experiencing storage issues, you can have an alert trigger the
moving of the virtual machine to a different storage location. This alert management
action is only available if the integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Move to a Different Storage, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine that you want to
move.
a. To move the virtual machine that triggered the alert, click Execute this
action.
This option is only available if the alert is built to trigger for virtual
machines.
If the option is not selected, the action will be performed live on the
virtual machine.
5. Under Select Target Datastore, search for the datastore where you want to
move the selected virtual machine.
a. In a VMware environment, select one of the available datastores.
b. In a Hyper-V environment, select one of the available datastores, and
click either Use the default location to move the virtual machine to the
default location of the datastore, or click Specify custom path, and enter
a custom location.
6. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
595
7. Select how frequently this action occurs for each triggered alert in Execution
Settings.
8. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine will be moved to a different datastore.
If a virtual machine is experiencing issues, you can have an alert trigger a pause for
the virtual machine. This alert management action is only available if the integration
with Virtualization Manager is enabled.
b. To pause a different virtual machine, click Select specific VM, and search
for a virtual machine.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine will be paused.
596
Available Alert Actions
If a virtual machine is experiencing issues, you can have an alert trigger the virtual
machine to be powered off. This alert management action is only available if the
integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Power Off, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine that you want to
power off.
a. To power off the virtual machine that triggered the alert, click Execute
this action.
This option is only available if the alert is built to trigger for virtual
machines.
b. To power off a different virtual machine, click Select specific VM, and
search for a virtual machine.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine will be powered off.
If a virtual machine is powered off, you can have an alert trigger the virtual machine
to be powered on. This alert management action is only available if the integration
with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Power On, and click Configure Action.
597
3. Under Select Virtual Machine, specify the virtual machine that you want to
power on.
a. To power on the virtual machine that triggered the alert, click Execute
this action.
This option is only available if the alert is built to trigger for virtual
machines.
b. To power on a different virtual machine, click Select specific VM, and
search for a virtual machine.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine will be powered on.
If a virtual machine is experiencing issues, you can have an alert trigger the virtual
machine to be restarted. This alert management action is only available if the
integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Reboot, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine that you want to
reboot.
a. To reboot the virtual machine that triggered the alert, click Execute this
action.
This option is only available if the alert is built to trigger for virtual
machines.
b. To reboot a different virtual machine, click Select specific VM, and
search for a virtual machine.
598
Available Alert Actions
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine restarts.
If a virtual machine is experiencing performance issues, you can have an alert trigger
the virtual machine to be suspended. This alert management action is only available
if the integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Suspend, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine that you want to
suspend.
a. To suspend the virtual machine that triggered the alert, click Execute
this action.
This option is only available if the alert is built to trigger for virtual
machines.
b. To suspend a different virtual machine, click Select specific VM, and
search for a virtual machine.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
599
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the specified virtual machine is suspended.
If a virtual machine is experiencing issues, you can have an alert trigger a snapshot
of the virtual machine to be taken. This alert management action is only available if
the integration with Virtualization Manager is enabled.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Manage VM - Take Snapshot, and click Configure Action.
3. Under Select Virtual Machine, specify the virtual machine of which you want to
take a snapshot.
a. To take a snapshot of the virtual machine that triggered the alert, click
Execute this action.
This option is only available if the alert is built to trigger for virtual
machines.
b. To take a snapshot a different virtual machine, click Select specific VM,
and search for a virtual machine.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met, a
snapshot is taken of the specified virtual machine.
The Play a Sound action uses the SolarWinds desktop notification client to play the
sound on your computer when an alert arrives.
600
Available Alert Actions
You must download and install the client on every computer that you want to play a
sound when an alert arrives. After installing the desktop notification client, configure
which sound you want to play when an alert is received.
Computers that do not have the desktop notification client installed on them do not
play a sound when an alert arrives. If you want an alert notification sound to play on
your desktop or laptop, you must install and configure the desktop notification client
on that computer.
The desktop notification client requires the following information to connect to your
SolarWinds Orion server and receive alerts:
You can use the server name and credentials that you use to logon to your
SolarWinds product.
SolarWinds can be configured to play a sound upon alert trigger or reset. This alert
action is frequently used in NOC environments. The SolarWinds Desktop Notification
client must be installed on each computer that you want to play a sound. The
following procedure configures a sound to play for an alert.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Play a Sound option, and then click Configure Action.
3. Under Play a sound settings:
n If not installed, click Download our desktop notification client to
download and install the notification client. From the notification client,
select an alert sound.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
601
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met, a
sound plays through the client.
If a computer is experiencing issues, you can have an alert trigger a Windows Net
Message to be sent to a specific computer or to all computers.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Send Net Message option, then click Configure Action.
3. Under Send a Net Message settings:
a. Enter Computer Name or IP address in the field provided.
b. Enter the Message of your alert trigger in the field provided.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
602
Available Alert Actions
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the message is sent to the selected computers.
If IIS or application pools are experiencing performance or resource issues, you can
use an alert to restart them.
You must know the IIS Server name and the Site or Application Pool to restart a
remote instance of IIS.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select Restart IIS Site/Application Pool from the options, and then click
Configure Action.
3. Expand Restart IIS Site/Application Pool Settings.
a. Select the IIS Action to Perform from the drop down list.
b. Choose the Site or Application Pool.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the selected site or pool restarts.
SNMP traps signal the occurrence of significant events by sending SNMP messages to
a monitoring device. You can have an alert trigger this action to inform you of these
events.
603
This action requires the following information:
n UDP port number
n SNMP version number
n SNMP credentials
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Send SNMP Trap option, then click Configure Action.
3. Under Send SNMP Trap Message:
a. Enter SNMP Trap Destinations in the field provided.
7. Select how frequently this action occurs for each triggered alert in Execution
Settings.
8. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the SNMP trap message is sent.
604
Available Alert Actions
1. When editing or adding an alert, click Add Action in an Action section of the
Alert Wizard.
2. Select the Send a GET or POST Request to a Web Server option, then click
Configure Action.
3. Enter a name for the action in the Name of Action field.
4. Under HTTP request settings:
a. Enter a URL in the field provided.
b. Select either Use HTTP GET or Use HTTP POST.
5. Expand Time of Day. Use this setting if you want to schedule this action. This
schedule does not the overall alert schedule.
a. Select either Schedule is controlled on the alert level, no additional
schedule for this action needed or Use special Time of Day schedule
for this action. If you choose the latter, Click Add Schedule and then
enter the time period over which you want to activate your alert action,
and then select the days on which you want to activate your alert action.
605
Send a syslog message
SolarWinds can log received alerts to the syslog of a designated machine for later
investigation. The following procedure configures an alert to send a message to a
designated syslog server.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Send a SysLog Message option, then click Configure Action.
3. Under Send a SysLog message settings:
a. Enter the Hostname or IP Address of the syslog server in the field
provided.
b. Select a Severity and a Facility from the drop down lists.
4. Enter the Message of your alert trigger in the field provided.
5. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
6. Select how frequently this action occurs for each triggered alert in Execution
Settings.
7. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the syslog message is sent.
This action sends an email from the product to selected recipients for investigation
into the cause of the alert.
Before configuring this alert you must first configure the default SMTP server
the product uses to send email. You can change the default SMTP server later
or use different SMTP servers for specific alerts.
606
Available Alert Actions
Configure the SMTP server in the alert action or from the Settings page.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Send an Email/Page option, then click Configure Action.
3. Enter recipients and the message.
n You must provide at least one email address in the To field, and
multiple addresses must be separated with commas. Some pager
systems require a valid reply address to complete the page.
n Messaging is disabled if both the Subject and Message fields are
empty.
4. Enter the SNMP information.
5. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
6. Select how frequently this action occurs for each triggered alert in Execution
Settings.
7. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the email or page is sent.
Setting a custom status can be useful if you want to change the status of a familiar
node, but does not affect actual, polled values. For example, if the custom status is
set to Up, but the server is down or unresponsive, packet loss continues to be 100%.
Alerts based on the status do not trigger in this instance, but alerts based on a polled
value, such as packet loss, do trigger.
607
When the status is set with an alert, the status does not update to the actual,
polled status. The status must be switched manually to a different status or
configured to use the polled status. Change the status to use the polled status
from the node details page or create a reset action to set the status to use the
polled status.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Set Custom Status option, then click Configure Action.
3. Under Change Object Status Manually:
a. Select Change to a specific status if you are creating a trigger action, and
choose a status.
b. Select Use polled status if you are creating a reset action.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the status for the object changes.
The Text to Speech Output action uses the SolarWinds desktop notification client and
your computer's speech synthesizer to convert text messages-to-speech messages.
The action notifies users of new alerts by reading the alert out loud. This capability is
especially helpful for users who are visually impaired or who are not always at their
desks to read alerts onscreen.
Download and install the client on each computer that you want to play a sound.
Then configure which synthesizer you want to play.
608
Available Alert Actions
SolarWinds uses Microsoft® Speech Synthesis Engine version 5.0. If you are under
active SolarWinds maintenance, you may also install and use other text-to-speech
engines by visiting the SolarWinds website. The following procedure configures text-
to-speech output for an alert trigger or reset.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Text to Speech Output option, then click Configure Action.
3. Under Text to Speech Output settings click Download our desktop notification
client to download, install, and configure the notification client.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the message is read.
You may specify that an alert be logged to the Windows Event Log either on the
SolarWinds server or on a remote server for later investigation. r.
1. When editing or adding an alert, click Add Action in the Trigger or Reset Action
section of the Alert Wizard.
2. Select the Windows Event Log option, then click Configure Action.
3. Under Event Log Settings:
a. Select either Use Event Log Message on Network Performance Monitor
Server or Use Event Log Message on a Remote Server.
609
b. Enter the Message of your alert trigger.
4. Schedule the action by selecting Time of Day > Use special Time of Day
schedule for this action. This schedule only applies to the alert action you are
editing.
5. Select how frequently this action occurs for each triggered alert in Execution
Settings.
6. Click Add Action.
The action is added to the trigger or reset action list, and you can test the action
using the Simulate button. When the trigger or reset conditions of the alert are met,
the alert message is added to the Windows Event log.
As of Orion Platform version 2015.1, alerts are no longer created with the desktop-
based, Advanced Alerts Manager or Basic Alerts Manager. Alerts are instead created
and managed in the SolarWinds Orion Web Console.
Alerts that you created in the desktop-based Alert Manager are migrated to the web-
based alerting engine when upgrading to Core version 2015.1 or later. Some alerts
may not be successfully migrated and include information about why they were not
migrated in the migration log. You can view the alert migration logs in the
informational banners displayed after you update your installation.
The suppression section has not been carried over to web-based alerting. Use
options, such as Condition must exist for more than, in the trigger conditions to
accomplish similar tasks.
Database changes
The following are a list of tables that have been changed that you may be using in
custom SQL queries:
610
Changes in the alerting engine
n History has been split into table-specific history tables, such as the AlertHistory
table.
The new alerting engine also includes the following new alerting tables:
n Actions
n ActionsAssignments
n ActionsProperties
n AlertActive
n AlertActiveObjects
n AlertConditionState
n AlertConfigurations
n AlertHistory
n AlertHistoryView (introduced in 2015.1.3)
n AlertMigrationLog
n AlertObjects
n AlertSchedules
For a list of database changes from Orion Platform version 2014.2 to version 2016.1,
including new tables, column changes, or data constraint or data type changes, see
the online Database Changes spreadsheet.
n ${Property} - The property the alert is monitoring. You can select a new
variable with the specific property you want to view.
n ${TriggeredValue} - The value that triggered the alert. You can select a
new variable with the specific property you want to view.
n ${AlertStartTime} - When the alert active. You can use the Time of Day
scheduler to control when the alert is active.
n ${AlertEndTime} - When the alert is no longer active. You can use the Time
of Day scheduler to control when the alert is not active.
n ${ObjectSubType} - Determines if the node supports SNMP or is ICMP only.
You can use Node.ObjectSubType as the macro name.
611
Alert migration to the web
The Advanced Alert Manager and the Basic Alert Manager are deprecated in
SolarWinds Orion Core 2015.1 and later. A web-based alerting engine replaces the
previous alerting engine and includes new alerting variables.
To facilitate using the web-based alerting engine, part of the upgrade process
migrates alerts created with the desktop-based alerting engine to the web-based
alerting engine. All alerts are migrated, including alerts that are disabled.
Migration issues
Some alerts may not be successfully migrated. The migration log records all alerts
that are migrated and includes error messages for alerts that either cannot be
migrated or that are not migrated successfully.
After an alert has been migrated, you can only view the alert definition through the
web-based Alert Manager. You can no longer click the alert in the views.
The following list provides the SolarWinds Server & Application Monitor properties on
which you can trigger alerts:
Component Name
612
Component Monitor Alerting Properties
Component Type
This allows you to base your alert criteria on component types. Specify the
component monitor type by value using the following table.
None 0
FTP Monitor 7
HTTP Monitor 6
HTTPS Monitor 14
IMAP4 Monitor 13
613
IMAP4 User Experience Monitor 30
JMX Monitor 49
NNTP Monitor 11
POP3 Monitor 12
SMTP Monitor 10
SNMP Monitor 32
614
Component Monitor Alerting Properties
WMI Monitor 19
Component Status
This allows you to alert on Critical, Down, Unknown, Up, and Warning status.
Response Time
Statistic Data
This allows you to alert on the process or service name. For example: dns.exe,
or AlertingEngine.
Percent CPU
This allows you to alert on the percentage of CPU in use of a monitored process
or service.
615
Percent Memory Used
This allows you to alert on the amount of virtual memory in use, in bytes, of a
monitored process or service.
Application Name
Application Status
SolarWinds SAM adds the following variables to the core SolarWinds Orion variables
when selecting APM-Application as the property type.
616
Application Monitor Variables for Alerts
617
${ComponentsWithProble ${N=SwisEntity;M=ApplicationAlert.Compone Provid
ms} ntsWithProblems} es a
comm
a-
delimi
ted list
of
compo
nents
in a
Down,
Unkno
wn,
Warni
ng, or
Critical
state.
618
Application Monitor Variables for Alerts
619
${ComponentsWithProble ${N=SwisEntity;M=ApplicationAlert.Compone List of
msFormattedHtml} ntsWithProblemsFormattedHtml} compo
nents
that
are
not Up
along
with
the
compo
nent
status.
Forma
tted
with
HTML
tags
for
events
that
appea
r on
the
web
consol
e.
620
Application Monitor Variables for Alerts
621
${ComponentsWithStatus ${N=SwisEntity;M=ApplicationAlert.Compone List of
Formatted} ntsWithStatusFormatted} compo
nents
with
compo
nent
status
includ
ed
format
ted
with
html
tags.
Html
format
ting is
used
for
send
e-mail
action
to
provid
e
impro
ved
appea
rance
of
listed
compo
nents.
622
Application Monitor Variables for Alerts
623
${LastTimeUp} ${N=SwisEntity;M=CurrentStatus.LastTimeUp} Provid
es the
date
and
time
the
applic
ation
was
last
seen
in an
Up
state.
624
Application Monitor Variables for Alerts
625
${SystemSummaryFormat ${N=SwisEntity;M=Application.ApplicationAle Syste
ted} rt.SystemSummaryFormatted} m
summ
ary.
HTML
format
ting is
used
for the
Send
e-mail
action
to
provid
e an
impro
ved
appea
rance
of the
listed
compo
nents.
626
Component Monitor Variables for Alerts
SolarWinds SAM adds the following variables to the core SolarWinds Orion variables
when selecting APM-Component as the property type.
627
Component Macro Definiti
Monitor Variable on
628
Component Monitor Variables for Alerts
629
${ComponentNam ${N=SwisEntity;M=ComponentAlert.ComponentNa Provides
e} me} the
name of
the
compon
ent, for
exampl
e, SW
Module
Engine.
630
Component Monitor Variables for Alerts
631
${MultiValueStatisti ${N=SwisEntity;M=ComponentAlert.MultiValueStat Statistic
cs} istics} s sent
when
alerting
on the
Multiple
Value
Chart.
632
Component Monitor Variables for Alerts
633
${PercentVirtualMe ${N=SwisEntity;M=ComponentAlert.PercentVirtual Provide
mory} Memory} s the
virtual
memory
used by
a
compon
ent as a
percent
age.
634
Component Monitor Variables for Alerts
635
${Threshold-CPU- ${N=SwisEntity;M=ComponentAlertThresholds.Thr Provide
Warning} esholdCPUWarning} s the
Warnin
g
threshol
d for
the
CPU.
636
Component Monitor Variables for Alerts
637
${Threshold- ${N=SwisEntity;M=ComponentAlertThresholds.Thr Provide
VirtualMemory- esholdVirtualMemoryWarning} s the
Warning} Warnin
g
threshol
d for
virtual
memor
y.
638
Component Monitor Variables for Alerts
639
${UserNotes} ${N=SwisEntity;M=ComponentAlert.UserNotes} Provide
s notes
from
the user
about a
compon
ent.
Change
s you
make
will
automat
ically be
saved.
Alerts may be shared with selected other SolarWinds products that are not part of
the SolarWinds Orion Platform, such as AlertCentral and Web Help Desk.
640
Integrate an Orion Platform product with ServiceNow
5. Include additional alert properties in the alert by clicking Insert Variable and
choosing the ones you want to include. This ensures that the variables you
used in the alert message are translated correctly to the other product.
Integrate your Orion Platform product with ServiceNow® to automatically open new
ServiceNow tickets based on critical events defined in your Orion Platform product.
The integration with ServiceNow allows for two-way communication between your
Orion Platform product and ServiceNow. By integrating the two systems, you can:
You can integrate one Orion Platform product with multiple ServiceNow
instances.
The integration requires NPM 12.0, SAM 6.3, or any other Orion Platform product
running Core version 2016.1 or later.
Before you can configure the integration details in your SolarWinds Orion product,
check the prerequisites and configure your ServiceNow instance.
641
n For minimum hardware and software requirements, see the administrator
guide of your product.
n Download the ServiceNow integration application from the ServiceNow app
store.
n Install the integration app and configure your ServiceNow instance for the
integration.
After downloading the SolarWinds Alert Integration application from the ServiceNow
store, deploy the application in ServiceNow.
When the installation is complete, the caption of the Install button will change to
Installed.
1. Navigate to the user administration section in ServiceNow, and create a new
user.
2. Provide a user ID, a password, and other required information.
3. Specify that the new user should have Web service access only.
4. Edit the newly created user, and add the x_sow_intapp.integration_
user role to the role list.
After installing the integration application and creating an integration user, you can
now configure the integration with ServiceNow in your SolarWinds Orion server.
642
Integrate an Orion Platform product with ServiceNow
1. In the Orion Web Console, click Settings > All Settings.
2. In the Alerts & Reports group, click ServiceNow Instances.
3. Click Add Instance.
4. Enter a name and the URL for the ServiceNow instance.
5. Enter the ServiceNow credentials:
n Username
The user name of the account that is configured for the SolarWinds
integration role.
n Password
6. Test the connection to your ServiceNow instance. If the connection is not
working, you receive descriptive messages to help you solve the issue.
7. If you are accessing your ServiceNow instance through a HTTP proxy, select Use
a HTTP proxy server, and click the Configure your HTTP proxy settings link to
edit the details. For more information, see Configure web proxy settings.
8. Click Save.
643
Reports
Creating and Viewing Reports
SolarWinds provides you with a wide array of predefined reports for each Orion module, and a web-based
interface that enables you to customize these predefined reports and create your own reports, which can
be printed or exported in a variety of formats.
In addition to using the Orion Web Console to view and create reports, you can also use the Orion Report
Writer to maintain legacy reports created prior to the introduction of the Web Console Report Interface.
The following sections provide detailed information related to creating, viewing, and managing SolarWinds
reports:
Your SolarWinds installation comes with many predefined reports that can be used as soon as there is
data to be reported on.
1. Click Start > All Programs > SolarWinds Orion > Orion Web Console.
2. On the Home tab, click Reports.
1. Click Start > All Programs > SolarWinds Orion > Alerting, Reporting, and Mapping > Report Writer.
These predefined reports are sufficient for most needs, but for specialized requirements, these can be
easily customized. You can also create entirely new report layouts. For more information, see Viewing,
Creating, Exporting, Importing, Editing and Scheduling Reports in the Orion Web Console.
Note: Legacy reports created prior to the introduction of the Web Console report interface can only be
edited using the Report Writer. For more information, see Using Report Writer.
Viewing, Creating, Exporting, Importing, Editing and Scheduling Reports in the Orion Web Console
The Reports tab in the Orion Web Console enables you to view, edit, create, export, print and schedule
reports for your SolarWinds Orion installation.
644
Note: The Orion Web Console does not allow you to edit legacy reports created with the Orion Report
Writer. Use the Report Writer to edit these. For more information, see Using Report Writer.
Modifying an existing web-based report is often the simplest way to generate a new report. You can add
pre-existing resources or create a custom table or chart. You can also edit information about each
resource.
1. Click Reports > All Reports in the menu bar, and click Manage Reports.
2. Select Report Origin in the Group by drop-down menu in the left pane, and select Web-based from
the list.
3. Select the report to use as the basis for your new report, and click Duplicate & Edit.
4. Click Add Content.
5. Select the resource to add to the report, and click Select and Continue.
Some resources require you to choose a specific object to report on. For example, if you want
to track how many people use a specific application, you must choose the application when
adding the resource.
6. Click the Edit button on the resources to make changes such as filtering the objects, group columns,
or setting a sample interval. Available options depend on the type of resource you add.
7. Click Next to display the Preview view, and click Next.
8. Add report properties, such as categories or custom properties. Use the report limitation category to
restrict the report to specific user accounts. Click Next.
9. Schedule the report by clicking Schedule this report to run regularly, and creating a new schedule or
adding the report to an existing schedule. Click Next.
10. Review the Summary and click Submit to save the report.
Web-based reports are created in the Orion Web Console, and can be restricted to specific users through
report limitations. Users may be assigned specific report limitation categories and can only view reports
that are in the same report limitation category.
SolarWinds recommends that you duplicate and edit an existing web-based report instead of
creating a new one.
1. Click Reports > All Reports > Manage Reports > Create New Report.
2. On the Layout Builder panel, click Add Content. You may be prompted to add content as soon as you
click Create New Report.
645
3. Select the first resource to add to the report and click Select and Continue.
Some resources require you to choose a specific object to report on. For example, if you want to track
how many people use a specific application, you must choose the application when adding the
resource.
The Layout Builder view is displayed with the selected resource added.
4. In the Content area, add resources and sections to the report. You can also modify the layout.
a. Click Add content to add resources to your report. For more information, see Add content to
a web-based report.
646
b. Click Add section to add more rows of content to this report.
5. To filter a resource to include a specific set of data, click Edit Resource. Not all resources can be
filtered.
647
6. Filter the resource and click Submit.
Each resource has different filter options.
7. After adding and filtering the resource, enter a report name, and click Next.
8. On the Preview panel, click Next.
9. Add report properties, such as categories, custom properties, or limitations, and click Next.
10. To schedule the report, click Schedule this report to run regularly, create a new schedule or assign a
schedule, and click Next.
You can schedule a report to be generated, emailed, saved, or printed.
11. Review the Summary and click Submit to save the report.
You can customize how the report looks, such as the width, header, or number of columns. By default a
report is 960 pixels wide with a header and footer, and a single column for content.
The maximum image size is 600 pixels wide and 240 pixels high.
648
4. In the Content area, change the number of columns or rows. You can select a predefined page layout
or manually add columns and rows.
n Enter a number in the Layout columns field to change the number of columns.
n Click Add section to add more rows
5. Select the Footer check box to include a footer in your report. Select each option you want included.
You can include any Orion Web Console resource, including charts and graphs, in a report.
The following procedure assumes you are already creating or editing a report in the Orion Web Console.
1. On the Layout Builder page, click Add Content in the column to which you want to add a new
resource.
2. Use the Group by field to filter the available resources or search for a specific resource.
The Classic category grouping provides the most comprehensive list of available resources.
3. Select the resource from the list in the main pane.
If you are an advanced user and want to add a Custom Chart or Table, see Add a custom chart
or table to a web-based report.
4. Click Select and Continue.
5. If the resource requires you to select specific objects:
a. Select the required objects from the left pane.
b. Click Add to Layout.
6. You can edit the resource if you want to change the title or subtitle.
7. If you want to add another row to your report, click Add section. You can now add content to this row
as described above.
You can create custom charts or tables for inclusion in web-based reports. Custom charts or tables are
usually added when you are familiar with your SolarWinds Orion database or are comfortable creating
SQL or SWQL queries. Because the Orion Platform generates so much data, you need to ensure that you
know exactly what data you are using, from which instances it originates from, and what you do with them
to ensure that your custom charts and tables show meaningful results.
You can reuse customized charts or tables by clicking Use previously specified objects when adding
the chart or table and then selecting the object.
1. Click Add Content in the column to which you want to add a custom chart.
2. Group by Reports to find the Custom Chart or Custom Table resources.
3. Select Custom Chart or Custom Table, and click Select and Continue.
649
4. Use one of the following methods to configure the objects displayed in the chart or table:
n Specific Objects (static selection) - use when you know which objects you want to include in
your chart or table.
a. Filter or search for the objects you want to include.
b. Select the objects' check boxes.
This is the most straightforward selection method, and recommended for new users. It
is also the preferred method for relatively permanent network objects.
This is the preferred selection method for groups of objects of a specified type that may
change over time. "All Cisco nodes in Austin" is an example of a group best defined
using the Dynamic Query Builder.
n Advanced DataBase Query (SQL, SWQL) - only use if you are comfortable querying your
SolarWinds database directly using SQL or SWQL.
a. Select SQL or SWQL, and enter your query.
b. Click Preview Results to test your query.
5. Enter a name for this selection in the Selection Name field, and click Add to Layout.
You must now edit the chart or table to choose the data series or columns you want to use and modify
display and filtering settings.
Once you have specified the objects for your custom chart, you need to select the data series. You can also
change the sample interval and filter the results.
1. If you have just added a custom chart, the Edit Resource page opens. You can open this page by
clicking Edit Chart on the resource in the Layout Builder page.
2. Click Add Data Series in Left Y-axis.
3. Filter or search for the data series, and select the one you want to use.
The groups available and the data series within these groups will depend on the object
selected.
4. Click Add Data Series. The data series is added to the Left Y-axis.
5. For additional settings for each data series, click More. Here you can:
n Edit the Display name for this data series.
n Select a custom Color for this data series.
n Show the 95th percentile line for this data series.
n Show Trend for this data series.
6. Enter a Custom label for the Left axis.
650
7. Select the Units displayed, Chart type, and select the Show the sum of all data series, if required.
8. Select the Sample Interval. This can be as frequent as once a minute to once a week. Data within
each sample interval are summarized so that a single point or bar is plotted for each of these
periods.
It is possible to select a sample interval that is longer than the reporting period.
You cannot use a separate time period or filter results settings for the right axis series.
11. Click Submit to return to the Add Report page.
Once you have specified the objects to be reported on for a custom table, you need to select the data
series. You can also sort and filter the results.
1. If you have just added a custom table, the Edit Resource page opens. You can open this page by
clicking Edit Table on the resource in the Layout Builder page.
2. Click Add Column.
3. Filter or search for the column, and select the column you want to use.
651
8. Restrict data in your table to a specific time period by selecting Yes from the Time-based settings
drop-down.
You can only do this if your table contains a column with historical data.
a. Select the column to use to specify the time period from the Date/Time column in this table
is drop-down.
b. Select the Sample Interval. This is used to summarize your data by time period.
9. Use the Group results by option to organize the table by the values in the columns you select.
10. Click Submit to return to the Add Report page.
Build conditions
Use the Dynamic Query Builder selection when objects may change over time. For example, as your
network ages, you will replace or upgrade various pieces of equipment. You can select each piece of
equipment individually, or you can create a dynamic query that adds objects to the custom chart or table
based on the properties you select.
Though the Advanced Selector provides access to all network object characteristics, the Basic
Selector provides access to a smaller subset of the most frequently used network object
characteristics.
1. Select the type of selector query you want to use (Basic or Advanced).
2. Select the type of objects to report on from the I want to report on drop-down.
3. Use the following steps if you choose Basic Selector:
a. Click Add Condition.
b. Select All child conditions must be satisfied (AND) or At least one child condition must be
satisfied (OR).
c. Select a property of the monitored object, a conditional relation, and provide a value.
d. Click Add Simple Condition if you want to add another condition.
4. Use the following steps if you choose Advanced Selector:
a. Select All child conditions must be satisfied (AND) or At least one child condition must be
satisfied (OR).
b. Select which field you want to evaluate, a conditional relation, and provide a value.
c. Click the + sign to add child conditions.
n Add Single Value Comparison (Recommended) - The child condition evaluates a single
field, like Status
n Add Double Value Comparison - The child condition evaluates two conditions, such as
Status and OS
n Add And/Or block - Adds a sub condition block
Use report limitation categories to limit access to any SolarWinds report created on SolarWinds Orion
Platform versions 2013.1 and later. Users with a report limitation category set can only see reports that are
in the same report limitation category.
652
The No Reports limitation is a special report limitation category that removes all access to reports
when applied to a user account. You do not need to add No Reports as a limitation in the report
properties.
n If you are running SolarWinds Orion Platform versions 2012.2.X or earlier, reports are stored
in a folder on the primary SolarWinds server (default location C:\Program
Files\SolarWinds\Orion\Reports). Place reports into subfolders and restrict user
access to the file system to limit user access.
n If you are running SolarWinds Orion Platform version 2013.1.X or later, reports are stored in
the SolarWinds database, and both users and reports may be assigned a report limitation
category to restrict who can access the report.
When you create or edit a report, expand Report Limitation on the Properties page to add a report
limitation. Choose an existing limitation or enter a new one.
After the report limitation is created and the report saved, the limitation is available in the user settings.
After the report limitation is saved, it is available in the user account's Define Settings page.
In the Report Limitation Category, select the limitation, and save your changes.
Scheduling Reports
Schedules enable you to set up report actions to occur at specific times. These actions let you generate
reports and print them, save them to disk or email them to selected recipients. You can create schedules
for single or multiple reports or assign reports to existing schedules. In addition, you can add URLs to the
schedules, so that screen captures of specific websites at the time the reports were generated are
included.
n Reports can be assigned to schedules either when they are being edited or created, or in the
Schedule Manager.
n Schedules can be created from the Report Manager, the Schedule Manager or from within the
creation or editing of a report.
You can directly assign a report to a schedule while editing the report.
1. Click on the Schedule Report tab to display the Schedule Report view.
2. Click Schedule this report to run regularly.
653
3. Click Create new schedule in the dropdown.
4. Enter an appropriate Schedule Name and Description.
5. Click Add Frequency and then complete the following steps:
a. Enter a name for this frequency.
b. Select:
n Specific Date(s) to select specific dates and times
n Daily to schedule the report actions to run every day
n Weekly to schedule the report actions to run once or more a week
n Monthly to select the month and the day of the month to run the report actions.
c. If you selected Specific Date(s), select the date(s) and time(s) when you want the scheduled
report actions to occur and then click Add Frequency.
Note: Click Add Time to select additional dates and times.
d. If you selected Daily, complete the following steps:
i. Select the number of days between scheduled report actions.
Note: to run the report on work days, select Business Day (Mon - Fri).
ii. Select the time(s) to run your report actions.
Note: Click Add Time to add additional dates and times.
iii. If you do not want the schedule to start immediately upon completion, select
Specific Date(s) in the Starting On field, and then select the date and time when you
want the schedule to start.
iv. If you want the schedule to end at some point, check Ending On, and then select the
date and time when you want the schedule to end.
v. Click Add Frequency.
e. If you selected Weekly, complete the following steps:
i. Check the days of the week to run the report actions.
ii. Select the time(s). You can click Add Time to add additional dates and times.
iii. If you do not want the schedule to start immediately upon completion, select
Specific Date(s) in the Starting On field, and then select the date and time to start.
iv. If you want the schedule to end at some point, check Ending On, and then select the
date and time for it to end.
v. Click Add Frequency. You can add multiple frequencies, if required.
f. If you selected Monthly, complete the following steps:
i. Select the months, days and times when you want to run your report actions.
Note: Click Add Time to add additional dates and times.
ii. If you do not want the schedule to start immediately upon completion, select
Specific Date(s) in the Starting On field, and then select the date and time when you
want the report schedule to start.
iii. If you want the schedule to end at some point, check Ending On, and then select the
date and time when you want the report schedule to end.
iv. Click Add Frequency.
654
6. Click Add Action, and select the action (Email, Print, or Save to Disk) to be executed on the configured
schedule, and then click Configure Action.
7. Enter a Name for the action.
8. If you selected Email:
a. In the To field, enter the email addresses of all recipients, separated by semicolons.
b. If you need to add CC or BCC addresses, click CC and/or BCC, and enter the email addresses
of these recipients.
c. To change the default name and address of the sender, click "-" and enter the
appropriate Name of Sender and Reply Address.
d. Click Message, and enter the Subject and Message for the email. You can compose the
message as HTML or Plain Text.
e. If you also want a printable version of your emailed reports, check Retrieve a Printable
Version of Reports.
f. Check the format(s) in which you want to provide the emailed report: PDF, CSV, Excel, or
HTML.
g. To include the URL of the emailed report so recipients can access it remotely, check
Include Report's URL
h. Click SMTP Server.
i. If you have already configured an SMTP server, select the Name of SMTP Server, and then
click Save.
j. If you have not already configured an SMTP server, select Add New Server, and then
complete the following steps:
i. Provide the Hostname or IP Address of your SMTP Server and the designated SMTP Port
Number.
Note: The SMTP server hostname or IP address field is required. You cannot send an
email without identifying the SMTP server.
ii. If you want to use SSL encryption for your emailed report, check Use SSL. This
changes the SMTP port number to 465.
iii. If your SMTP server requires authentication, check This SMTP Server requires
Authentication, and then provide requested credentials.
k. Click Add Action.
9. If you selected Print:
a. Provide a Windows User name, using domain\username format, and Password for a user
with access to the printer on which you want to print your report.
b. Click Printer Settings.
c. Click Select, and then select the printer to which you want to send the report.
d. Click Select.
e. Enter the number of Copies, the Layout, whether you want Color or Black and white printing,
and the Margins to be applied.
f. Click Add Action.
655
10. If you selected Save to Disk:
a. Enter the Network Share Location where you want to save the report.
b. If you also want a printable version of your saved report, check Retrieve a Printable Version of
Reports.
c. Enter the Windows User name, using domain\username format, and Password for a user
with access to the Network Share Location.
d. Select the format(s) in which you want to provide the saved report (PDF, CSV, or Excel).
e. Click Add Action. You can add multiple actions.
To run the report on work days, select Business Day (Mon - Fri).
656
iii. If you do not want the schedule to start immediately upon completion, select Specific
Date(s) in the Starting On field, and select the date and time when you want the
schedule to start.
iv. If you want the schedule to end at some point, check Ending On, and select the date
and time when you want the schedule to end.
v. Click Add Frequency.
e. If you selected Weekly, complete the following steps:
i. Check the days of the week to run the report actions.
ii. Select the time(s). You can click Add Time to add additional dates and times.
iii. If you do not want the schedule to start immediately upon completion, select Specific
Date(s) in the Starting On field, and then select the date and time to start.
iv. If you want the schedule to end at some point, check Ending On, and select the date
and time for it to end.
v. Click Add Frequency. You can add multiple frequencies, if required.
f. If you selected Monthly, complete the following steps:
i. Select the months, days of the month and times at which you want to run this schedule.
Click Add Time to add additional dates and times.
ii. If you do not want the schedule to start immediately, select Specific Date(s) in the
Starting On field, and then select the date and time when you want the report schedule
to start.
iii. To set an end date and time for the schedule, check Ending On, and then select the date
and time when you want the report schedule to end.
iv. Click Add Frequency
9. Click Next to display the Actions view.
10. Click Add Action, and select the action (Email, Print, or Save to Disk) to be executed on the configured
schedule, and then click Configure Action.
11. Enter a Name for the action.
12. If you selected Email:
a. In the To field, enter the email addresses of all recipients, separated by semicolons.
b. To add CC or BCC addresses, click CC and/or BCC, and enter the email addresses of these
recipients.
c. To change the default name and address of the sender, click "-" and enter the appropriate
Name of Sender and Reply Address.
d. Click Message, and enter the Subject and Message for the email. You can compose the
message as HTML or Plain Text.
e. If you also want a printable version of your emailed reports, check Retrieve a Printable
Version of Reports.
f. Check the format(s) in which you want to provide the emailed report: PDF, CSV, Excel, or
HTML.
g. To include the URL of the emailed report so the recipients can access it remotely, check
Include Report's URL.
h. Click SMTP Server.
657
i. If you have already configured an SMTP server, select the Name of SMTP Server, and click
Save.
j. If you have not already configured an SMTP server, select Add New Server, and complete the
following steps:
i. Provide the Hostname or IP Address of your SMTP Server and the designated SMTP Port
Number.
The SMTP server hostname or IP address field is required. You cannot send an
email without identifying the SMTP server.
ii. To use SSL encryption for your emailed report, check Use SSL. This changes the SMTP
port number to 465.
iii. If your SMTP server requires authentication, check This SMTP Server requires
Authentication, and provide requested credentials.
k. Click Add Action.
13. If you selected Print:
a. Provide a Windows User name, using domain\username format, and Password for a user
with access to the printer on which you want to print your report.
b. Click Printer Settings.
c. Click Select, and then select the printer to which you want to send the report.
d. Click Select.
e. Enter the number of Copies, the Layout, whether you want Color or Black and white printing,
and the Margins to be applied.
f. Click Add Action.
14. If you selected Save to Disk:
a. Enter the Network Share Location where you want to save the report.
b. If you also want a printable version of your saved report, check Retrieve a Printable Version of
Reports.
c. Enter the Windows User name, using domain\username format, and Password for a user
with access to the Network Share Location.
d. Select the format(s) in which you want to provide the saved report (PDF, CSV, or Excel).
e. Click Add Action. You can add multiple actions.
15. Click Next to display the Summary view.
16. If the schedule summary is correct, click Create Schedule.
17. The schedule is display in the Schedule Manager.
Edit a schedule
1. Click the Schedule Manager tab.
2. Select the schedule you want to edit and click Edit Schedule.
3. The Properties view for the schedule is displayed.
658
Assign a report to a schedule or multiple schedules
1. Select the report you want to assign.
2. Click Schedule Report > Assign Existing Schedule.
3. Confirm that you want to assign the report by selecting the schedule or schedules in the Assign
existing schedule list and clicking Assign Schedule(s).
The Report Scheduler provides a list of all report schedules that have been set up for your Orion web-
based reports. You can create, edit, run and delete schedules from this page, and assign reports to
schedules.
Exporting Reports
The most appropriate format for exporting a report depends on how you want to use the exported file. The
different formats, in which Orion reports can be exported, are shown below.
XML a
659
Orion Web Console Orion Report Writer
Excel a a
PDF a a
Before using Report Writer, you must have collected at least a few minutes' worth of data in a database
populated with devices you want to monitor. A variety of reports are included with Report Writer, and icons
that precede report names distinguish available report types. The following procedure starts Report
Writer.
1. Click Start > All Programs > SolarWinds Orion > Alerting, Reporting, and Mapping > Report Writer.
2. Click File > Settings.
3. In the General tab of the Report Writer Settings window, select either of the following as a default
viewing mode:
Note: You can toggle between Preview and Report Designer modes at any time by clicking Preview
or Design, respectively, on the toolbar.
l Preview displays the report as it will appear in printed form. For more information, see
Preview Mode.
l Report Designer is the report creation and editing interface. For more information, see
Design Mode.
4. If you want to separate the data for individual network objects with horizontal lines, click
Report Style, and then check Display horizontal lines between each row.
5. Click OK to exit Report Writer Settings.
For more information about creating reports in Report Writer, see Creating and Modifying Reports in
Report Writer.
Preview Mode
Preview mode shows a report as it will print. When you open a report in Preview mode, or switch to
Preview mode from Design mode, Orion runs the query to generate the report, and then Report Writer
displays the results.
The Preview window toolbar provides the following actions and information:
660
Note: Double-click a preview to zoom in and double-right-click to zoom out.
l Print report
Design Mode
Use Design mode to create new reports and modify or rename existing reports. The options available for
creating and modifying reports are the same. Design mode options are also dynamic, based upon the type
of report, included report data, and report presentation. The options available depend on the type of
report being designed, but all reports require that you select the data to include and decide how that data
will be sorted, ordered, filtered, and presented.
To add your company logo as the report header and footer, save your logo as Header.jpg in the
SolarWinds\Common\WebResources folder, typically located in C:\Program Files\, and then click
Refresh.
The image must be in JPEG format with a height of no more than 150 pixels.
1. To modify an existing report, click an existing report from the inventory in the left pane of the
main Report Writer window.
2. To create a new report, click File > New Report.
3. Select the type of report that you would like to create, and then click OK.
Each report offers different configuration options, so, depending on the report, some formatting tabs
described in the following sections may not be available.
Notes:
l The SQL query used to generate a report may be viewed in an additional tab. Click Report > Show
SQL to add a read-only SQL tab to the Design window.
l A preview of your report is also available at any time. Click Preview to enter Preview Mode, and then
click Design to return to Design Mode.
See the following documents for more information about configuring reports in Report Writer:
661
General Options Tab
The General tab is displayed by default, showing titling and display options.
1. Specify the Report Group, Report Title, Subtitle, and Description.
Note: If you use an existing report group name, the new report is added to that existing group in the
left pane of the main window.
2. Select the display Orientation of your report.
3. If you are configuring an historical report and you do not want to group data by days, clear
Group historical data by days.
Note: By default, data in some availability and historical reports is grouped by days when displayed
in the Orion Web Console. Data grouping by days is not viewable in Report Viewer.
4. If you do not want to make this report available on your Orion Web Console, clear Make this
Report available from the Orion website.
Note: By default, most reports are made available for display in the Orion Web Console. Customize
views.
The Select Fields tab allows you to select the data fields in a report.
662
Note: Unchecked fields are not displayed in your report, but their sort and function configurations
are retained.
6. If you want to preview your report, click Preview.
The Filter Results tab allows you to generate filter conditions for field data by selecting appropriate
descriptors from the linked context menus. Filters are configured as follows.
To configure filters:
1. Click Browse (… ), and then select from the following options:
l Select Add a new elementary condition to generate a condition based on a direct comparison
of network object data fields.
l Select Add a new advanced elementary condition to generate a condition based on a
comparison of device data fields and values.
l Select Add a new complex condition to define a condition that filters other defined
conditions.
l Select Delete current condition to remove a selected condition.
n Select Move current condition forward or Move current condition backward to change the
order of your conditions accordingly.
Note: The lists of available linked descriptors are dynamically generated in consideration of all other
variables within the same condition.
2. Check or clear individual filter conditions to enable or disable their application, respectively, to your
report.
You can limit the number of records shown in your report to either a top number or a top percentage of all
results. Top XX options are configured as shown below.
1. If you want to show all records in your report, select Show All Records.
2. If you want to specify a truncated list of eligible items for your report, complete the following
steps:
a. Select either Show only the Top number Records or Show the Top percentage % of Records
b. Provide appropriate number or percentage values.
You can limit the scope of your report to a specific period of time. To configure Time Frame options, select
a Named, Relative, or Specific Time Frame, and then select or provide required values.
Notes:
l If you receive a SQL Timeout error message, you may edit the timeout setting in the
SWNetPerfMon.db file. By default, this file is located in the C:\Program Files\SolarWinds\Orion
directory
663
l Since the Relative Time Frame is continuously variable, reports run with it may show different
results, even if they are run close together in time.
You can generate summaries of your results over specific periods of time using the Summarization tab.
1. If you do not want to summarize your results, confirm that Do not Summarize the Results is
selected.
2. If you want to summarize your results, complete the following steps:
a. Select Summarize the Results by Hour, Date, Month, etc., and then select the summarization
period.
b. Specify the location of the summary field for your report.
c. Select a location for the Summary Date/Time field.
The Report Grouping tab allows you to group results by field descriptor within your report. Add, edit and
delete report groups to organize the data in your report. Establish and edit report groups as follows.
1. If you want to add a new report group, select a field from the list to define your group, and then
click Add Report Group to add your selected field to the Report Groups list.
Note: Use up and down arrows to change the grouping order accordingly.
2. If you want to edit an existing report group, select the field from the Report Groups list, and then
click Edit Report Group.
3. The following options may be changed as needed:
l The Group Header is the text that designates groups on your report.
l The Web URL is the dynamic location of your published report with respect to your Orion
Web Console.
l Font size, face, color, and background may all be modified by clicking associated ellipses.
l Alignment may be left, center, or right.
l Check Transparent Background for better results when publishing your report to the Web.
4. If you want to change the grouping order, use the up and down arrows to change the grouping
order accordingly.
The Field Formatting tab allows you to customize the format of the various results fields in your report. To
format results fields, select the field you want to format, and then edit labels and select options as
appropriate.
664
Notes:
l The formatting options available for each field may be different according to the nature of the data
contained in that field.
l Check Hidden Field to hide any field in your report.
l To view your changes at any time, click Preview.
SolarWinds reports respect Orion Web Console account limitations. For security, by default, reports are not
available to users with limited accounts unless an Orion administrator specifically provides access. The
following procedure creates a reports folder for an account-limited user and configures the
account-limited user to access Orion reports from it.
Note: For more information about creating user accounts, Create users. For more information about
applying account limitations to user accounts, Restrict user access to network areas by applying
limitations.
The Orion Report Writer provides an export menu that enables you to save you report in all formats listed
above except XML. To export to XML, you need to use the SolarWinds Orion Web Console.
1. Click Start > All Programs > SolarWinds Orion > Alerting, Reporting and Mapping > Orion Report
Writer.
2. Click on the report you want to export.
3. Click File > Export.
665
4. Click on the required file format.
5. Type a name for the exported file.
6. Click Save.
OrionGlobalSearch
Search syslogs, traps and objects monitored in the Orion Web Console globally
SolarWinds NPM 11.5 introduces the technical preview of Orion Global Search. This feature provides a
global search interface in the Orion Web Console and allows you to search for information contained in
traps, syslogs, alerts, events and in the database of objects monitored in SolarWinds Orion.
This feature is Technical Preview. Any functionality in this feature may be subject to change upon
official release. This feature is not fully supported at this time and should be used carefully.
1. Go to your installation folder, run the Orion Global Search executable, and complete the installation.
By default, you can find the executable using the following path:
<ProgramData Folder>\Solarwinds\Installers\OGSinstaller.msi
2. Run the Configuration Wizard.
If you want to also search through historical syslogs and traps, select the option to index existing
entries.
If historical syslogs and traps are not relevant for you, you do not have to index syslogs and traps.
Indexing runs in the background, and can be time-consuming, depending on the amount of data
being indexed.
n Go to Program Features (for example, navigate through Start > Control Panel > Program Features),
right-click SolarWinds Orion Global Search, and select Uninstall.
When you are notified about an event or issue, search for textual keywords from the notification,
such as a user name, application impacted, IP address, remote site name, performance counters or
error message.
When a user reports poor connectivity, you can search for his computer name or IP address.
666
1. Log in to the Orion Web Console.
2. Enter a keyword into the Search Orion box in the top right corner of the Orion Web Console, and click
the Search icon.
This will open the results of the basic search in the Global Search view.
n Orion Global Search performs a full text search of the string you enter into the search
field. If you want to search for a certain sequence of words, enclose the phrase by
quotation marks (" ").
n You can also use auto-complete of search queries and properties.
3. Refine the search to narrow down items you are interested in.
Adjust the time period
n To prolong or shorten the time period which is relevant for your search, select the
appropriate item in the Time Period list below the search line.
n To specify a precise time period, click the links next to From and To items to define start and
end date of the period you are interested in.
Refine filters
Refine the search with filters available by default.
Add filters
Add more filters.
Remove filters
Remove an already applied filter.
Locate the property which you want to remove from the search below the search line and click
x to remove it.
4. Display information about individual search result items:
n To display information about an object in the results list, position the cursor over it. A tooltip
displays with relevant information about the object. For nodes, relevant details might include
the status, polling IP address, machine type, average response time, packet loss, and CPU
load.
n To view events and alerts concerning the object, click the + before the item in the results list.
Orion Global Search allows you to specify the information you are looking for by entering a query into the
search box.
Supported queries consist of database field names (also called properties) and database field values.
These can be further connected by logical operators.
[database field name]:[field value] [LOGICAL OPERATOR] [database field name]:[field value]
Example:
667
For more information about automatic suggestions provided for any input into the global search field, see
Auto-completing queries and properties in Orion Global Search.
Orion Global Search has a powerful auto-complete feature which helps you specify what information you
are looking for in logs and NPM. The auto-complete feature suggests available properties and modifiers
which you can use to tailor a query to suit your needs.
Auto-suggestions include
n Field names from the Orion database. These are object properties that can be used to design a
search query for Orion Global Search.
n Logical operators that allow you to combine multiple properties, such as AND, OR, or NOT.
Note: Auto-suggestions only include available properties, not values available for them. To be able to
use auto-suggestions, you need to add an appropriate value to limit the search results by.
1. Log on to the Orion Web Console and execute an Orion Global Search.
2. Now in the Global Search view, start typing a value or property you want to search for. A list of
suggestions will display below the search field.
3. Use the arrow keys to move in the list and press <Enter> to add the selected suggestion into the
search field.
4. Fill in the required field value to be searched for.
5. If you want to further specify your query, use a logical operator, such as AND. Then you can add
another field name and value that you are interested in finding.
The Refine Further section in the Orion Global Search view provides default filtering options based on the
keyword you entered. You can find their properties and their values available in the results of the current
search.
In most cases, default filters include the object type (for example Nodes, Interfaces, Components,
SqlServerApplication, and so on), and their status (for example Disabled, Down, Up, Unknown).
1. Log into the Orion Web Console and execute a global search.
2. In the Refine Search section, select the items which you want to have in the results.
3. Click Update results.
The results will now only show items corresponding with the selected properties. Applied properties
display below the search field.
If you have refined your filter too much, or need to apply a different approach to filtering, you can remove
properties used for filtering.
668
To remove a filter, locate the filter below the search field, and click x for property filters that you do not
want to apply on the search results any more.
You can further limit Orion Global Search results to display information related only to objects with
specified properties. This can be done by adding a filter property and specifying values which should be
included in the results.
For example, you might want to see log and NPM information only for loopback interfaces.
1. Log on to the Orion Web Console and execute an Orion Global search.
2. Now in the Global Search view, click Add Filter Property.
3. Select the appropriate Orion Object in the Available Columns list, and then select the required
property in the Database Column name table.
Example: To search for loopback interfaces information, select Interface in the Orion Object
list, and then select Interface Type Description.
4. Click Add Filter Property.
The selected property with available values will display in the Refine Further area.
Example: If you selected Interface Type Description, it will display in the Refine Further area,
with all available values, such as loopback, Ethernet, ppp, and so on.
5. Select one or more property values by which you want to limit the search results, and then click
Update Results.
Example: If you are interested only in results concerning loopback interfaces, select loopback
below Interface Type Description, and update the results.
The selected filters display below the search field. If you want to exclude the selected property from
filtering the results again, click x next to the appropriate property.
The Refine Further area displays only the properties and values that are available in your SolarWinds
Orion database and in your logs.
669
SolarWinds
Server & Application Monitor
Version 6.2.4
Administrator Guide
671
Table of Contents
Before you install 37
Introduction 38
Applications Defined 39
SAM hardware requirements 44
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers 49
Agent requirements 51
Server sizing 54
Recommendations 55
672
Orion Common Components Administrator Guide
Recommendations for multi-CPU systems and the optimal settings of the I/O subsystem 57
Enable FIPS 60
SAM technology requirements 67
673
(Undefined variable: Core.TOC)
Customize resources 87
Customize views 95
674
Orion Common Components Administrator Guide
Minimize SNMP processing load during discoveries using the Discovery Ignore List 144
675
(Undefined variable: Core.TOC)
Groups 157
Add a summary view menu item to the menu bar in the Applications tab: 177
178
Manage nodes, applications, and settings from the web console 181
676
Orion Common Components Administrator Guide
Add, edit, and delete credentials within the Credentials Library 189
189
Create and assign credentials using Quick Credentials when editing a template or
application monitor. 193
677
(Undefined variable: Core.TOC)
View events, alerts, traps, and syslogs in the Orion Web Console Message Center 237
Requirements for monitoring Microsoft Hyper-V, VMware ESXi, and ESX Servers 245
678
Orion Common Components Administrator Guide
679
(Undefined variable: Core.TOC)
Install and configure the SolarWinds Alert Integration application in ServiceNow 343
680
Orion Common Components Administrator Guide
Adapt an existing Perl script to a Linux/Unix Script component monitor in a new template 378
Adapt an existing Visual Basic script to a Windows Script Monitor in a new template 384
681
(Undefined variable: Core.TOC)
445
682
Orion Common Components Administrator Guide
Agents 518
683
(Undefined variable: Core.TOC)
684
Orion Common Components Administrator Guide
Alerting 560
685
(Undefined variable: Core.TOC)
Reports 644
Viewing, Creating, Exporting, Importing, Editing and Scheduling Reports in the Orion Web
Console 644
OrionGlobalSearch 666
Search syslogs, traps and objects monitored in the Orion Web Console globally 666
NetworkAtlasAdminGuide 671
686
Orion Common Components Administrator Guide
687
(Undefined variable: Core.TOC)
References 755
Zooming 763
Zooming 826
Change thresholds for the Top Indexes for Database performance counter 843
Changing the number of tables displayed in this resource requires values be changed in two
locations 843
Change the thresholds for the Top Indexes for Database performance counter 847
Change thresholds for the Top Tables for Database performance counter 849
Zooming 863
Zooming 899
Zooming 1006
Zooming 1009
688
Orion Common Components Administrator Guide
1034
1034
689
(Undefined variable: Core.TOC)
Agents 1048
Viewing and customizing application and component performance and status 1051
1054
JSON 1060
690
Orion Common Components Administrator Guide
Definitions 1061
Drivers 1067
Firmware 1068
Memory 1073
Peripherals 1077
Processors 1079
General 1085
Hardware 1085
691
(Undefined variable: Core.TOC)
Availability 1102
692
Orion Common Components Administrator Guide
Zooming 1105
Zooming 1109
693
(Undefined variable: Core.TOC)
Add, edit, and delete credentials within the Credentials Library 1171
1171
694
Orion Common Components Administrator Guide
695
(Undefined variable: Core.TOC)
696
Orion Common Components Administrator Guide
697
(Undefined variable: Core.TOC)
698
Orion Common Components Administrator Guide
Characters 1281
Anchors 1283
Quantifiers 1284
Dot 1286
Alternation 1287
Solutions 1295
Troubleshooting 1297
699
(Undefined variable: Core.TOC)
Configure Distributed Component Object Model (DCOM) and User Account Control (UAC) 1305
700
Orion Common Components Administrator Guide
701
(Undefined variable: Core.TOC)
702
Network Atlas tooltip variables
For example, the variable ${CPULoad} will parse with the current processor
utilization of the node you are viewing.
VARIABLE DESCRIPTION
VARIABLE DESCRIPTION
703
VARIABLE DESCRIPTION
${DD} Current day of the month (two digit number, zero padded).
704
General variables for Network Atlas tooltips
705
GENERAL VARIABLE DESCRIPTION
Date and time of the last event for this Alert. (Windows
${AlertTriggerTime}
control panel defined “Short Date” and “Short Time”).
VARIABLE DESCRIPTION
The date and time of the last change made to the definition of
${LastChanged} a group. This does not include changes made to group
members resulting from dynamic queries.
706
Interface variables for Network Atlas tooltips
VARIABLE DESCRIPTION
VARIABLE DESCRIPTION
707
VARIABLE DESCRIPTION
708
Interface variables for Network Atlas tooltips
VARIABLE DESCRIPTION
709
VARIABLE DESCRIPTION
710
IP SLA variables for Network Atlas tooltips
VARIABLE DESCRIPTION
VARIABLE DESCRIPTION
711
VARIABLE DESCRIPTION
VARIABLE DESCRIPTION
712
Node variables for Network Atlas tooltips
VARIABLE DESCRIPTION
713
VARIABLE DESCRIPTION
714
Node variables for Network Atlas tooltips
VARIABLE DESCRIPTION
715
Volume variables for Network Atlas tooltips
VARIABLE DESCRIPTION
716
Wireless variables for Network Atlas tooltips
VARIABLE DESCRIPTION
VARIABLE DESCRIPTION
Date and time when the node was last polled by the
${WirelessLastStatPoll}
wireless poller.
Network Atlas
Network Atlas is an application for creating custom maps and network diagrams. It is
preinstalled with your Orion Platform product.
Maps provide a graphical depiction of the network. You can export or print maps, and
use them to document your network. You can also view Network Atlas maps in the
Orion Web Console.
717
What customization options are there?
n Customize the map background with default colors, textures, or images. Add
custom background graphics, such as floor plans.
n Link dynamic real-time weather or natural disaster maps to your network maps
as the background.
n Customize the shape, size, color, and style of map links to illustrate the status
of the relative bandwidth of associated objects.
n Select a graphical style for objects to reflect the network status on maps.
n Nest maps, so that you can drill down to reveal increasing levels of detail, and
the status of nested map child objects may be bubbled up to the parent map.
You can for example nest floor maps into a map of a building, and be notified if
devices on the floor map are down.
Network Atlas is pre-installed on Orion EOC and SolarWinds NPM, and it can be run
as a local application on those Orion servers.
Users can also run Network Atlas as a standalone application on a remote computer.
Network Atlas users must have the Map Management rights in SolarWinds NPM or in
Orion EOC.
The user logged in to Network Atlas must be able to access the Network Atlas
synchronization folder to ensure synchronization with the SolarWinds Orion
database.
SERVER
REQUIREMENTS
COMPONENT
Memory 1 GB
Hard Drive
150 MB
Space
718
Start Network Atlas
SERVER
REQUIREMENTS
COMPONENT
If you do not see the download link in the Map resource, click Edit, select
Show Network Atlas Download Link, and click Submit.
4. Save the installer (NetworkAtlas.exe) on the remote computer.
5. Run the installer on the remote computer, and click Next on the Welcome
window.
Users must have the Map Management right in SolarWinds NPM or in Orion
EOC.
719
c. If you are connecting to an SolarWinds NPM server, select Orion as the
Connect To target.
d. If you are connecting to an Orion EOC server, select EOC as the Connect
To target.
e. Click Connect.
4. Now on the Network Atlas Welcome screen, select what map you want to open:
n To open a recent map, select it in the Open Recent section.
n To open a map available in a certain location, click Browse and navigate
to the map.
n To create a new network map, click Network Map in the Create New
section. See Create network maps.
n To create a wireless heat map, click Wireless Heat Map in the Create
New section. See Create wireless heat maps.
Before you start creating maps, prepare a map management strategy. Consider the
following recommendations:
n Map only static objects. If objects move, you need to adjust their location on
maps, and it is difficult to keep maps up-to-date.
n Build maps to match the column width of your Orion Web Console views.
Rescaling maps in views results in distorting of icons and texts.
720
Create network maps
1. If you are creating a new map, click the Network Atlas button ( ), and click
New Map.
2. If you are adding objects to an existing map:
a. Click the Network Atlas button ( ).
b. Click Open Map.
c. Navigate to your existing map, and click Open.
3. Expand and navigate the node tree in the left pane to locate the network nodes
and monitored objects you want to add to your map.
4. Drag selected objects onto the drawing area.
n To add all the objects of a type on a node to your map, click + next to
the node name to reveal all its associated monitored network objects,
and drag all objects in the object group onto the drawing area.
Using the ConnectNow tool, Network Atlas can automatically draw lines between
directly connected nodes on your network.
721
ConnectNow displays connections based on data polled for nodes with enabled L2
and L3 topology pollers, and for unidentified nodes.
An unidentified node is a node that was found on the network but which is not
managed by Orion. These devices might be switches, hubs, routers, or other devices
without names or addresses.
Unidentified nodes can be virtual, generated to signify an indirect connection in your
map. For example, when a topology calculation cannot find any direct connections
between two nodes, an unidentified node is generated between the two known
nodes.
722
Create network maps
You can represent network links in your map by drawing lines between map objects.
If a connected object is down, any connected links change color to red.
You can use anchor points to change the shape of object links on your map. Use
multiple anchor points to create more complex shapes and curves.
1. Select in the Tools group, or click the middle mouse button.
2. Click and drag the link you want to reshape.
Links created on Network Atlas maps are not merely connectors between network
objects. They can display status of the connection, the link speed, or utilization.
723
5. To add a label, right-click a link, and select Add Label. A default label appears.
Edit the label text or move the link label.
6. To specify what should be displayed for connections:
a. Expand Connection Display Options.
b. To display the link speed, select Show Link Speed.
c. To show the link utilization in percent, select Link Utilization.
To hide all labels for the connections, clear the Include Link Labels, and
click Don't Show Additional Info.
You can set interfaces through which linked objects are connected. Links can then
display the status, speed or link utilization of the connection. Interface states and
performance data are determined from SolarWinds NPM polling data.
Connections are shown as either solid or dotted lines. A solid line indicates that the
connection is UP. A dotted line indicates that the connection is DOWN.
The connection status depends on the status of interfaces at both ends of the
connection.
724
Create network maps
The following table shows how interface states are reflected in the status of a
connection between NodeA, with InterfaceA, and NodeB, with InterfaceB.
InterfaceB Status
UP DOWN UNKNOWN
UP UP DOWN UP
Map links can show either interface utilization or interface connection speed. A
legend is available to interpret colors representing interface performance data.
725
Add a background
You can select colors, textures, and locally-hosted or Internet-hosted images to serve
as your map backgrounds.
To clear the current map background, click Home, and click Background > Clear
Background ( ).
The default values are the smallest area bounding the existing map
objects and labels.
4. Select a texture, and click OK.
Add images accessible on the hard drive or on the Internet as the background for
your maps.
726
Create network maps
n To ensure optimal quality of images, plan graphics to display at full size in the
Orion Web Console.
n When determining map size and resolution, consider web page layouts and
display screen resolutions.
Supported formats
Linked backgrounds are updated when you access the map, or refresh the browser
page.
1. Open the map in the Network Atlas, and click Home.
2. To use a background image the disk, click Background > Background Image, and
navigate to the image.
3. To use a background image from the Internet:
a. Click Background > Linked Background.
b. Type the URL of the image.
c. Click Validate.
d. Click OK.
727
Add a dynamic background for a map
Weather conditions can affect availability of a certain location. You can add weather
maps displaying the current weather as a background for maps.
1. Navigate to the page which you want to link as the background, and copy the
static link.
2. Open the map in the Network Atlas.
3. Click Linked Background, and paste the URL.
4. Validate the URL, and click OK.
The dynamic map will now display as the map background.
When you add the map to the Orion Web Console, the map will refresh every time the
Orion Web Console refreshes.
Save maps
Network Atlas saves your maps directly to the server to which you are connected.
Open maps
Maps are loaded from the Orion server to which you are connected. They appear in
the left pane of the Network Atlas window.
1. Click + to expand the Maps group in the left pane of the Network Atlas window.
2. Double-click the map you want to open.
Wireless heat maps help you visualize wireless signal coverage on a building floor
plan.
728
Create wireless heat maps
Wireless heat maps are only supported for Cisco wireless controllers. The
wireless controllers you want to see on wireless heat maps must be managed
in SolarWinds NPM.
See also Display wireless heat maps in the Orion Web Console.
The wireless heat map poller collects information about the signal strength on
monitored access points. By default, this poller is disabled on your devices because
of performance issues.
Network Atlas enables the wireless heat map poller on wireless controllers used in
wireless maps because the information collected by the poller is required for
including access points into wireless heat maps.
729
When do I need to disable the wireless heat map poller?
If you experience performance issues when working with wireless heat maps, disable
the wireless heat map poller on the devices.
Disabling the poller resolves performance issues, but your wireless heat maps
will no longer be updated. The Orion Web Console resources and the Network
Atlas will both display the last status generated before you disabled the
wireless heat map poller.
Clicking the grey Off icon for the nodes in the Poller Status column
disables the poller for the nodes. The icon will turn to green On, and the
poller will be disabled.
The floor plan should reflect the real dispositions of the office or buildings on the
map, so that you can correctly position the wireless access points and reflect the
wireless signal coverage on your map.
730
Create wireless heat maps
Requirements:
The floor plan must be a graphic file in one of the following graphics formats:
n Graphics Interchange Format (.gif, non-animated)
n Tagged Image File Format (.tiff)
n Joint Photographic Experts Group (.jpg)
n Microsoft Windows Bitmap (.bmp)
n Portable Network Graphics (.png)
To ensure the readability of wireless heat maps, use black and white
images.
The correct scale is necessary for an accurate display of the wireless coverage
provided by your wireless access point.
You can use online maps, such as the full version of Google Maps, to measure
your office building. Locate the building on Google Maps, right-click one wall,
and measure the distance to the other wall of the building.
Requirements
n You have already inserted a background image for your wireless heat map (a
floor plan).
n You know the distance of two objects displayed on the background image.
To minimize error, set the scale for the longest distance possible, such
as the building or floor length.
731
To set the map scale:
To generate a wireless heat map, add wireless access points used by client devices
into the map.
Requirements
n The wireless LAN controllers must already be managed in your Orion Platform
product.
n Only Cisco controllers are supported.
n The wireless heat map poller must be enabled on the wireless LAN controllers
that you use in the map.
732
Create wireless heat maps
Improve the accuracy of wireless heat maps by taking samples of the signal strength
on real devices
Wireless heat maps display the ideal wireless signal coverage, they do not count with
physical obstacles, such as office walls. To make wireless heat maps more real,
measure the signal strength on real devices, such as cell phones, laptops, or tablets
connected to your wireless network. The measured values are stored as signal
samples and used for calculating the signal coverage on wireless heat maps.
Take signal samples in places where you expect the signal to be blocked by
walls or other obstacles, or in places where the signal strength does not
correspond with your heat map.
Take signal samples with cell phones, because polling the signal is usually
faster for them.
Take a wireless device, walk it to a certain location, and take a signal sample
there. Then, walk the device to another location, and take another signal
sample. This procedure is called "walking edition" because it requires you to
walk through the office.
If you have multiple devices connected to your wireless access points, take
multiple signal samples at once (called "sitting edition" because you can do it
sitting at your desk).
Signal samples stay in the map and influence the calculation of wireless heat
maps even after the client moves from its position.
When you move access points in a map, the signal samples might not be
accurate any more. Delete obsolete signal samples, and add new ones.
Requirements
n You need to have a wireless heat map created and open in the Network Atlas.
n You need to have wireless access points added into the map.
733
n You need to have clients, such as cellular phones, tablets, laptops, connected to
the access points positioned in your wireless heat maps.
734
Display Network Atlas maps in the Orion Web Console
n If there are too many devices, use the search box to find the
devices you want to use for creating signal samples.
n Measuring the wireless signal strength can take a few minutes.
n If the signal measuring fails, you can either repeat the
measurement for the device, or restart the wizard.
4. Network Atlas will automatically regenerate the map according to the defined
signal samples. Click Close to hide the Signal Sample wizard tab.
If your wireless signal coverage on your wireless heat maps is not as expected, you
can take the following troubleshooting measures.
n Make sure that the map scale you have entered is precise.
n Make sure that your access points are located correctly.
n Verify that signal samples are up-to-date.
n The signal samples stay in the map even after the device you measured the
signal strength on moves away. If you change the position of your access
points, or the dispositions of your office, the signal samples might not be
accurate and could affect the calculated wireless heat map.
n Delete obsolete signal samples.
To delete a signal sample, open the wireless heat map in the Network Atlas,
select the signal sample, and press the Delete key.
n Add new signal samples. See Improve the accuracy of wireless heat maps by
taking samples of the signal strength on real devices.
To see a graphical overview of devices on your network, create a Network Atlas map,
add the Map resource on the view, and specify the map you want to see in the
resource.
735
1. Log in to the Orion Web Console as an administrator.
2. Click Edit in the Map resource.
3. Select your map from the Select Map list.
4. Click Submit.
1. Log on to the Orion EOC web console with an administrator account.
2. Click Settings.
3. Click Manage Views.
4. Select Home, and click Edit View.
5. Click Resource.
6. Click Network Map in the Added list.
7. Select the map from the Select Network Map list, and click Save.
8. Click OK, Save Changes.
9. If prompted to confirm your changes, click OK.
10. Click the Home view to see the map.
n Add the Map resource on the view, click Edit, select the map in the list,
and click Submit. See Add resources and columns to views, and define
subviews for more details about adding the resource.
736
Display Network Atlas maps in the Orion Web Console
By default, the wireless heat map is regenerated once a day, and the information
about clients connected to wireless access points is collected every 5 minutes.
View the location of clients connected to access points in the Orion Web Console maps
To be able to view clients in a wireless heat map, you must add at least three
access points and one signal sample, or four access points into the map.
Viewing the location of connected clients is supported only for Cisco access
points with CleanAir technology.
1. Create a wireless heat map in the Network Atlas. See Create wireless heat
maps.
2. Log in to the Orion Web Console, and open the wireless heat map in the
Wireless Heat Map resource. See Display wireless heat maps in the Orion Web
Console.
3. Make sure the Show Connected Wireless Clients option is selected.
You should now be able to see clients connected to access points available on
the map.
If you cannot see a client on the map, its position might be calculated
outside of the selected map. To verify this, consult the Displaying item in
the legend. If the map shows less clients than are actually connected,
such as one out of three, it means that the remaining clients are either
outside of the map, or filtered out.
737
Limit the number of clients displayed on the map
Too many clients on the map might make the map crowded, and could also cause
performance issues. A wireless heat map can show a maximum of 100 clients.
738
Advanced mapping techniques
Zoom into a map to enlarge details or to zoom out to reduce its size. Zoom level is a
visual aid, and it is not saved with the map.
Nested maps allow you to navigate through a map to see multiple levels of detail.
For example, a map of the United States can include an icon for a child map of
Oklahoma. You can then click the Oklahoma object to open the child map.
Each child map can include a view of the objects, either devices or other maps,
deployed on it.
Click any nested object to view the next level of map detail, until you reach the final
network device and see all available network information.
739
The total number of objects on a map, including objects on child maps, affects
how fast the map loads in the Orion Web Console. If your maps load slowly,
decrease the number of map objects.
Display the status of child objects on maps, and change metric thresholds
The status of a map object icon reflects its current state, such as up or down. You can
add a secondary status indicator to a map object to reflect metrics such as response
time, CPU load, or the state of any child objects. This secondary status indicator
appears at the bottom right corner of the status icon.
n The secondary status indicator respects the Orion Web Console Status
Rollup Mode setting for displaying status.
740
Advanced mapping techniques
n All child objects and selected metric thresholds are taken into account to
determine secondary status.
Independent objects and floating labels do not have associations to network nodes or
resources.
Changing the graphics that represent map objects allows you to increase the
information density of your map without increasing the map complexity.
1. Click the Orion Network Atlas button , and click Network Atlas Settings.
2. Click Graphic Styles in the left column.
3. Select an appropriate default style for each available map object.
For example, you can set an object icon to visually designate the type of the
monitored device. You can then select a status style, such as 3D Pad Underneath, to
illustrate the object status.
741
3. If you want the map object to appear as a fixed-size, LED-type graphic,
complete these steps:
a. Select Orion LED Status Icon.
b. Select a style from the Orion LED Status Icon Style list, and click OK.
4. If you want the map object to appear as a scalable shape, complete these
steps:
a. Select Shape.
b. Select a style from the Shape Style list, and click OK.
c. Drag a corner handle on the map object to resize the shape.
5. If you want the map object to appear as a scalable graphic, complete these
steps.
a. Select Graphic.
b. Click Select Graphic, select an appropriate graphic, and click OK.
c. Select a status style from the Graphic Style list, and click OK.
d. Drag a corner handle on the map object to resize the graphic.
You can paste graphics from the Windows clipboard into Network Atlas maps, and
display an overlay behind them to depict their status.
Icons that you paste into Network Atlas are saved to the SolarWinds Orion database,
and made available for reuse in other maps under the "Imported" icon grouping.
Pasted icons saved to the SolarWinds Orion database can be used by remote
instances of Network Atlas.
1. Open the icon image in a graphics program, such as Visio or Photoshop.
2. Copy the image to the Windows clipboard with the Copy command.
3. Open the appropriate map in Network Atlas.
4. Paste the image as a new object following these steps:
a. Right-click on the map and then click Paste.
b. Select Paste the Image From the Clipboard as a New Object.
c. Enter a name for the image.
d. Click OK.
The added icons are also saved on the SolarWinds Orion server in the
path
742
Delete a custom icon
%APPDATA%\SolarWinds\NetworkAtlas\Maps\Orion\<orion
server address>\NetObjects\Imported.
%APPDATA% is typically located in C:\Users\<logged on
user>\AppData\Roaming
Up status iconName-up.gif
743
Add custom icons from graphics files
1. Prepare the icons and save them as .gif or .wmi files.
2. On your SolarWinds NPM server, paste the icons into the following folder:
%APPDATA%\SolarWinds\NetworkAtlas\Maps\Orion\<orion server
address>\NetObjects\User Graphics.
%APPDATA% is typically located in C:\Users\<logged on
user>\AppData\Roaming
3. Start Network Atlas on the SolarWinds NPM server.
You can now assign the custom icons to objects on Network Atlas maps.
Customize the width, color, and line styles of network links in maps
The color setting only changes the color of links that have the Up status.
Customize labels
744
Assign a custom icon to an object
Customize the page that opens when you click on a map object
By default, map objects are linked to the most relevant details page for the object.
Customize the URL hyperlink to link to external web sites and pages.
http://orionServer/Orion/NetPerfMon/MapView.aspx?Map=ma
pName
745
orionServer
mapName
This is the display name of the map. If the name contains space characters,
substitute %20 for the spaces when specifying the name.
When you hover over map objects in the Orion Web Console, a tooltip with the
current identification and status of the object appears.
Customize tooltips for all map object types in the Orion Web Console to display
additional information using alert variables, custom properties, and other text.
746
Environment requirements
Maps created for use in SolarWinds NPM must be converted before they may be
used in Orion EOC.
The Orion to EOC Map Converter utility imports maps into Orion EOC v1.5 from other
SolarWinds Orion products.
Environment requirements
n Orion EOC must currently be managing at least one SolarWinds Orion server.
n If Orion EOC is configured to use Active Directory accounts to access Orion
servers, confirm that you have entered the password for the AD account in the
Orion Logins section of EOC. Additionally, only AD accounts that were
individually added to the Orion Server may be used to import a map. Active
Directory group accounts are not compatible with Map Converter.
User requirements
To run the Orion to EOC Map Converter utility, the user must also meet the following
specifications:
n The user must run the Map Converter using a Windows Administrator account
that also has Orion EOC Administrator role permissions.
n The user must log into the Map Converter using an Orion EOC account that was
individually added to Orion EOC. Active Directory group accounts are not
compatible with Map Converter.
n The user must have Orion EOC access to at least one Orion server.
n The user must have Node Management rights on the remote Orion server
747
2. Execute SolarWinds-OrionToEOCMapConverter-1.5.exe, and complete
the installer.
3. Provide members of the Users group Full Control of files in the folder
<volume>:\Windows\Microsoft.NET\Framework\v2.0.50727\Tempor
ary ASP.NET Files. See Microsoft TechNet Library for more information.
4. Allow the Everyone group Full Control to the folder
<volume>:\Windows\Temp\SolarWinds\NetworkAtlas\EOC\SolarWin
ds\NetworkAtlas\MapsWeb\EOC\localhost and all of its child objects.
See Microsoft TechNet Library for more information.
1. Log in to the Orion EOC server with a Windows Administrator account that has
Orion EOC Administrator role permissions.
2. Start the converter utility by running Convert Orion Maps to EOC in your
SolarWinds program folder.
3. Select the Orion server hosting your maps from the Orion list.
4. Select the maps you want to import into Orion EOC.
To edit the name of an Orion EOC map you are importing, click the map
name in the New Name column, and edit the name.
5. Click Import.
Maps you import from different Orion servers may share the same name.
Resolution: Rename the maps so that each has a unique name in Orion EOC.
748
Advanced map layouts
If using an operating system that has UAC, you must run the program
using Run as Administrator.
Set when a map is displayed as Up on parent maps using the Up status threshold
The UP status threshold is the percentage of map objects that must be in an up state
on a given map for the map to be represented as up on the parent map.
1. Right-click any empty portion of the map, and select Map Properties.
2. Slide the Map Status Will Be UP slider to configure the up state threshold on
the Map Properties page.
If Orion Web Console users have account limitations that prevent them from seeing
network nodes, set whether the users should see the restricted nodes on maps.
Users with restricted access to the nodes will only see the restricted nodes, but
cannot retrieve any additional information about the nodes.
1. Right-click any empty portion of the map, and select Map Properties.
2. Select Remove Nodes That Users Do Not Have Permission to View.
1. Right-click any empty portion of the map, and select Map Properties.
2. Select Allow All Users to View All Nodes On This Map.
Users with account limitations, but with the permission to run and use the
Network Atlas can change this setting in the map. To prevent this, do not give
node management permissions to users who have account limitations.
749
n Distribute map objects
n Arrange map objects according to a layout style
Drag objects from the tree on the left to the appropriate position on the map.
Display grid
A grid guide helps you maintain structural and spatial relationships as you arrange
your map objects.
Grids are neither saved with a map, nor displayed in the Orion Web Console.
Customize grid
750
Advanced map layouts
751
BUTTON FUNCTION DESCRIPTION
Use circular layouts for maps containing ring and
star network topologies.
Emphasizes the symmetrical patterns inherent in
the map topology. It emphasizes an even
distribution of objects, and minimizes edge
Symmetrical crossings. Object groups have star spiral
placements.
Use symmetrical layouts for maps that have fairly
homogenous or uniform clusters.
Emphasizes mapped dependency relationships by
placing objects at different levels.
Hierarchical
Use hierarchical layouts to depict data
dependencies.
Emphasizes compact drawings, and uses only
horizontal and vertical edges. Objects are enlarged
if necessary to provide enough space for edge
Orthogonal connections.
Use orthogonal layouts for maps that need to depict
multiple clusters in a space-efficient manner.
752
Access remote nodes
Using Integrated Remote Desktop
Sometimes it is necessary to console into a remote server to troubleshoot an issue. This can be
accomplished within the Orion Web Console.
1. Open the Node Details view for the server you want to view remotely.
The easiest way to open the Node Details view is to click the remote server you want to view in
any All Nodes resource.
Depending on the security settings of your browser, you may be asked to install an ActiveX
control for remote desktop viewing. Follow all prompts to install this required control.
3. Verify the Server IP address or hostname, select an appropriate Screen Size, and then click Connect.
753
Access nodes using HTTP, SSH, and Telnet
For more information, search the MSDN online help for "Registering an Application to
a URI Scheme".
To use the remote access applications, web browser integration for the user
account must be enabled. Navigate to the user account, and ensure Allow
Browser Integration is set to Yes.
754
References
For information on specific SAM technologies, refer to the following sections:
n Understanding Agents
n AppInsight Applications
n The AppStack environment
n The Template and Application relationship
n Understand component monitors
n Monitor hardware health
n Understanding Quality of Experience
n Monitor external nodes
n Create new alerts to monitor your environment
n Application availability and status
n Charts in the SolarWinds web console
n Predefined Web Console Based Reports
755
AppInsight Applications
AppInsight applications provide a level of detail and expert knowledge far beyond what a simple template
can provide, allowing you to monitor virtually every aspect of the assigned application.
Like any unassigned application in SAM, AppInsight applications are considered templates until applied.
Therefore, it is a member of the Application Monitor Templates collection.
Once applied to a node, AppInsight applications are considered applications. Like any SAM application,
AppInsight applications are comprised of multiple component monitors, also known as performance
counters.
756
AppInsight for SQL
SAM offers a detailed view of your SQL databases' performance without the use of agents or templates by
using the AppInsight for SQL embedded application.
Like any unassigned application in SAM, AppInsight for SQL is considered a template until it is applied.
Therefore, it is a member of the Application Monitor Templates collection.
n Details View : Unlike a traditional Application Details view, the AppInsight for SQL Details view is
comprised of two tabs, or sub-views, that host a variety of resources and information:
n Summary Tab: This view displays an informative summary about the current SQL instance.
n Queries Tab: This view displays details about the most expensive queries running across all
databases on the current SQL instance.
l Database Details View : This view displays details about the selected database.
l Performance Counter Details View : This view displays details about the selected performance
counter.
From here, you can select from the drop down menu and choose to display different amounts of data
based on a time range, as shown below:
Editing Resources
Both the titles and subtitles of each resource can be changed by clicking Edit in the upper right-hand
corner of any resource, and then clicking Submit.
757
Additionally, certain resources allow you to add and remove component monitors from the resource. You
can do this by clicking the Edit button, and then checking the component monitors you want to keep.
758
Understand the AppInsight for SQL details view
The AppInsight for SQL Details view is the equivalent of the Application Details view of a traditional SAM
application; however, there are some notable differences:
n Details view: Unlike a traditional Application Details view, the AppInsight for SQL Details view is
comprised of two tabs, or sub-views, that host a variety of resources and information:
n Summary tab: This view displays an informative summary about the current SQL instance.
n Queries tab: This view displays details about the most expensive queries running across all
databases on the current SQL instance.
n Database Details view : This view displays details about the selected database.
n Performance Counter Details view: This view displays details about the selected
performance counter.
From here, you can select from the drop down menu and choose to display different amounts of data
based on a time range, as shown below:
Editing Resources
Both the titles and subtitles of each resource can be changed by clicking Edit in the upper right-hand
corner of any resource, and then clicking Submit.
The time and date displayed at the top of each resource (where applicable) shows the range of data
currently loaded into the resource. This, along with the Sample Interval Range, can be changed by clicking
Edit from within the resource.
Additionally, certain resources will allow you to add and remove component monitors from the resource.
You can do this by clicking Edit and then checking the component monitors you want to keep.
759
AppInsight for SQL Details View (Summary Tab)
The Summary tab provides a great deal of information about the current SQL instance. The available
resources unique to this view include:
n All Databases
n Application Availability
n Application Details
n Buffer Manager
n Cache
n Connections
n Disk
n Latches and Locks
n Memory
n Pages
n Sessions
n SQL Agent Job Status
n SQL Errors
n SQL Event Log Message Details
n SQL Server
n Top 10 Databases by Active User Connections
n Top 10 Most Expensive Queries by CPU Time
760
All Databases
This resource shows the status of all monitored databases on the current SQL instance.
n Name: Displays the name of the listed database, in addition to the current performance status as
indicated by the icon. Clicking the name of the database will take you to the Database Details page.
n Status: Displays the Online or Offline status of the listed database.
n Database Size: Displays the current size of the listed database.
n Transaction Log Size: Displays the size of the transaction log associated with the listed database.
761
Active Alerts
n Time of Alert: Displays the time and date the listed alert was triggered.
n Object Name: Displays the object that triggered the alert. Clicking the object takes you to the details
page for that object.
n Message: Displays the message of the listed alert.
762
Application Availability
This resource graphically shows the various states of an application in a percentage format and is made
up of three sections: the legend, the main chart, and the lower chart. The colors of the main chart
correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific time range by dragging the mouse over a
small area of the chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
763
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over. By default, all statistics are shown in the main chart.
764
Application Details
This resource provides tools and details concerning the current application.
n Management: This provides tools allowing you to more easily manage and troubleshoot the current
application.
n Instance Name: Displays the name of the current SQL instance.
n Status: Displays the status of the current SQL instance.
n SQL Server Version: Displays the version of the current SQL server.
n SQL Server Product Level: Displays the maturity level of the current SQL version.
n SQL Server Edition: Displays the edition of the current SQL Server.
n Clustered with: If the listed SQL Server is in a cluster, this field shows a listing of the servers that
make up the cluster. If the cluster is managed by SAM, a status icon becomes visible. If the cluster is
not managed in SAM, no status icon is visible.
765
Buffer Manager
This resource contains performance counters specific to the current status of buffers. The icons of the
listed performance counters in the Statistic Name column change color to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Total Definition:
pages This performance counter returns the number of pages in the buffer pool
Information:
The returned value includes database, free, and stolen pages.
Note: This counter is not available in SQL 2012.
Buffer Definition:
Cache Hit Indicates the percentage of pages found in the buffer cache without having to read from
Ratio disk. The ratio is the total number of cache hits divided by the total number of cache
lookups over the last few thousand page accesses.
766
Information:
After a long period of time, the ratio moves very little. Because reading from the cache is
much less expensive than reading from disk, you want this ratio to be high. Generally, you
can increase the buffer cache hit ratio by increasing the amount of memory available to
SQL Server. The higher this ratio, the less often SQL Server has to go to the hard disk to
fetch data, and performance is boosted overall. This counter averages the Buffer Cache Hit
Ratio from the time the last instance of SQL Server was restarted. This counter is not a
real-time measurement, but an average of all the days since SQL Server was last restarted.
In OLAP applications, the ratio could be much lower because of the nature of how OLAP
works.
Possible problems:
If the returned value is low, this could indicate that your SQL server may not have enough
memory to function at peak performance.
Remediation:
Check your SQL server and verify its memory is being used efficiently. Applications other
than SQL may be using a great deal of memory. Try and recover memory by closing
unnecessary applications. Installing additional memory may also help.
Lazy Definition:
Writes/sec The lazy writer is a system process that flushes out buffers that contain changes that must
be written back to disk before the buffer can be reused for a different page and makes
them available to user processes.
Information:
This counter tracks how many times per second that the Lazy Writer process is moving
dirty pages from the buffer to disk in order to free up buffer space. The Lazy Writer
eliminates the need to perform frequent checkpoints in order to create available buffers.
Generally speaking, this should not be a high value, say more than 20 per second. Ideally, it
should be close to zero. If it is zero, this indicates that your SQL Server's buffer cache is
large and your SQL Server does not need to free up dirty pages.
Possible problems:
If the returned value is high, this can indicate that your SQL Server's buffer cache is small
and that your SQL Server needs to free up dirty pages.
Remediation:
Check your SQL server and verify its memory is being used efficiently. Applications other
than SQL may be using a great deal of memory. Try and recover memory by closing
unnecessary applications. Installing additional memory may also help.
767
Free List Definition:
Stalls/sec Indicates the number of requests per second that had to wait for a free page.
Information:
This displays the frequency with which requests for available database pages are
suspended because no buffers are available.
Possible problems:
If the returned value is high, this indicates that not enough memory is available for the SQL
Server.
Remediation:
Check your SQL server and verify its memory is being used efficiently. Applications other
than SQL may be using a great deal of memory. Try and recover memory by closing
unnecessary applications. Installing additional memory may also help.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
768
Cache
This resource contains monitors specific to the current status of the cache. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Cache Definition:
Used/min This displays the number of times the cache object has been looked up.
769
Information:
This is not incremented when parameterized queries find a plan in the cache. However,
this can be incremented multiple times when using Showplan. Good plan reuse is one sign
of a healthy system. Compiling a query plan can be a CPU-intensive operation, especially
with complex queries, so reuse is encouraged.
Possible problems:
If the returned value is low, this can indicate ineffective reusing of plan cache which could
cause a CPU spike. Conversely, if the returned value is high for a large number of plans, this
could indicate that your cache space is being taken up with plans that were compiled and
used once to execute an ad hoc query, then never used again.
Remediation:
A database setting that can be helpful to plan reuse is forced parameterizaton. (You can set
this using the following command: ALTER DATABASE <databaseName> SET
PARAMETERIZATION FORCED). Normally, the query optimizer is very conservative when
deciding what queries can be parameterized, but this setting makes the optimizer be more
liberal in choosing parameters.
Cache Definition:
Object This performance counter returns the number of cache objects in the cache.
Counts
Information:
The Plan Cache object provides counters to monitor how SQL Server uses memory to store
objects such as stored procedures, ad hoc and prepared Transact-SQL statements, and
triggers. Multiple instances of the Plan Cache object can be monitored at the same time,
with each instance representing a different type of plan to monitor.
Possible problems:
High numbers of total cached objects use portions of the physical memory available to a
SQL instance on a per database basis. This can result in one database cache impacting the
performance of other local databases due to memory contention.
Remediation:
Increase the memory available to SQL services, reduce the number of databases on this
instance of SQL, or examine the volume of ad hoc queries running against the server.
Cache Definition:
Objects This performance counter returns number of cache objects in use.
in Use
Information:
The Plan Cache object provides counters to monitor how SQL Server uses memory to store
objects such as stored procedures, ad hoc and prepared Transact-SQL statements, and
triggers. Multiple instances of the Plan Cache object can be monitored at the same time,
with each instance representing a different type of plan to monitor.
770
Possible problems:
High numbers of cached objects in use consume the memory available to a SQL server at a
higher rate than non-active objects on a per database basis. This can result in one
database cache impacting the performance of other local databases due to memory
contention.
Remediation:
Increase the memory available to SQL server, reduce the number of active objects,
consolidate stored procedures, consolidate and convert ad hoc queries to stored
procedures where possible, or reduce the number of databases on the server.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
771
Connections
This resource contains monitors specific to the current status of the active connections. The icons of the
listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
User Definition:
Connections The User Connections performance counter identifies the number of different users that
are connected to your SQL Server at the time the sample was taken.
772
Information:
You need to watch this counter over time to understand your baseline user connection
numbers. Since each user connection consumes some memory space, a high number of
user connections can impact throughput and cause a performance slow-down. Once you
have an idea of your high and low thresholds during normal usage of your system, you
can then look for times when this counter exceeds these high and low marks.
Possible problems:
If the returned value of this counter goes down and the load on the system remains
stable, you might have a bottleneck that is not allowing your server to handle the normal
load. Keep in mind that this counter value might go down just because less people are
using your SQL Server instance. If you see this number jump by 500% from your baseline,
you may be seeing a slowdown of your server activity.
Remediation:
You may want to boost the SQL Server configuration setting, Maximum Worker Threads to
a figure higher than the default setting of 255. The setting for Maximum Worker Threads
should be higher than the maximum number of user connections your server ever
reaches.
Logins/sec Definition:
This performance counter returns the total number of logins started, per second, and
does not include pooled connections.
Information:
Opening and closing connections is an expensive process. A pooled connection is one
which is kept open by an application for other requests to re-use.
Possible problems:
If the returned value is high, this can indicate that the application is not correctly using
connection pooling.
Remediation:
Review the Connection Polling configuration.
Logout/sec Definition:
This performance counter returns the total number of logout operations started, per
second.
773
Information:
Opening and closing connections is an expensive process. When applications do not use
a connection pool, each request needs to establish its own connection before the query
can be executed. It then has to close it. A pooled connection is one which is kept open by
an application for other requests to re-use.
Possible problems:
If the returned value is high, this can indicate that the application is not correctly using
connection pooling.
Remediation:
Review the Connection Polling configuration.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
774
Disk
This resource contains monitors specific to the current status of the disk. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Information:
The returned value indicates the average time of read data from the disk. 4-8ms is
ideal. The returned value is considered acceptable up to 20ms. Any higher value needs
further investigation.
Possible problems:
If a value greater than 15-20ms is reported, this may indicate disk bottlenecks.
Remediation:
Increase the number of hard disks.
775
Average Disk Definition:
sec/Write This performance counter shows the average time, in seconds, of a write of data to the
disk.
Information:
The returned value indicates the average time of write data from the disk. 4-8ms is
ideal. The returned value is considered acceptable up to 20ms. Any higher value needs
further investigation.
Possible problems:
Values greater than 15-20ms nay indicate disk bottlenecks.
Remediation:
Increase the number of hard disks.
Forwarded Definition:
Records/Batch This performance counter identifies the use of a pointer which has been created when
Requests variable length columns have caused a row to move to a new page in a heap.
Possible problems:
Rows with Varchar columns can experience expansion when Varchar values are
updated with a longer string. In the case where the row cannot fit in the existing page,
the row migrates and access to the row traverses a pointer. This only happens on
heaps (tables without clustered indexes).
Remediation:
Evaluate clustered indexes for heap tables. In cases where clustered indexes cannot
be used, drop non-clustered indexes, build a clustered index to Reorg pages and rows,
drop the clustered index, then recreate non-clustered indexes.
Forwarded Definition:
Records/sec This performance counter returns the number of records fetched through forwarded
record pointers.
Information:
Tables without a clustered index. If you start with a short row, and update the row
creating a wider row, the row might not fit on the data page. A pointer is put in its
location and the row is forwarded to another page.
Possible problems:
Look at the code to determine where the short row is inserted followed by an update.
Remediation:
Can be avoided by:
776
1. Using default values so that an update does not result in a longer row that is the
root cause of forwarded records.
2. Use Char instead of Varchar. This fixes the length so that an update does not
result in a longer row.
Information:
This performance counter is deceptive because it makes no accommodation for
multiple spindles. Thus, the more spindles (i.e. physical hard disks) you have, the
higher the percentile values can go. Conversely, if these spindles are shared across
LUNs or other services, you may have high numbers on this counter without any
correlation to SQL Server activity. The value for this counter should be below 50%.
Possible problems:
If this performance counter sustains an average above 70%, you may have contention
with your drive or RAM.
Remediation:
You should increase number of hard drives used by SQL server.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
777
Latches and Locks
This resource measures the time it takes for latches and locks to perform various operations.
Latches perform the task of thread synchronization. For example, if a thread is reading a page from disk
and creating a memory structure to contain it, it creates one or more Latches to prevent corruption of
these structures. Once the operation is complete, the Latches are released and other threads are able to
access that page and memory structure again. For the most part, latches are transient, taking a few
milliseconds to complete.
A Lock prevents different users from overwriting each others changes. Generally speaking, a lock lasts for
the duration of the transaction.
The icons of the listed performance counters in the Statistic Name column change color to reflect the
listed counter's current state. Clicking any performance counter in the Statistic Name column takes you to
the Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
778
Counter Expert Knowledge
Latch Definition:
Waits/sec This performance counter displays the number of latch requests that could not be
granted immediately.
779
Information:
This ratio should be less than 10. Monitoring the latches to determine user activity and
resource usage can help you to identify performance bottlenecks.
Possible problems:
If the returned value is high, it is likely there is an I/O or memory bottleneck.
Remediation:
Check your SQL server and verify its memory is being used efficiently. Applications
other than SQL may be using a great deal of memory. Try and recover memory by
closing unnecessary applications. Installing additional memory may also help.
Lock Definition:
Requests/sec This performance counter returns the number of requests for a type of lock, per second.
Possible problems:
If the returned value is high, this can indicate that the queries are accessing large
numbers of rows. If you notice a high Average Wait time, then this could be an
indication of blocking.
Information:
Blocking is an unavoidable characteristic of any relational database management
system (RDBMS) with lock-based concurrency. On SQL Server, blocking occurs when one
Server Process ID (SPID) holds a lock on a specific resource and a second SPID attempts
to acquire a conflicting lock type on the same resource. Typically, the time frame for
which the first SPID locks the resource is very small. When it releases the lock, the
second connection is free to acquire its own lock on the resource and continue
processing. This is normal behavior and may happen many times throughout the course
of a day with no noticeable effect on system performance.
Remediation:
High Read queries should be reviewed. The simple way to fix locking is just kill the
connection that is causing the lock. Fixing locking, blocking, and deadlocking issues is
often a matter of redesign. You should examine either the schema of your database
and/or the way the application is designed. One of the most efficient ways to deal with
locking is to ensure that the design of your system does not have to deal with excessive
locks. The best way to do this is to normalize your tables, using more atomic structures
that allow the query to get in and get out faster. Another method is to code with the
locks in mind. If the design requires less normalization, you have to evaluate the
programs to ensure that they have the right isolation levels.
780
Lock Definition:
Waits/sec This performance counter reports the number of times users waited to acquire a lock
over the past second.
Information:
Note that this counter only gets incremented only when you “wake up” after waiting on
the lock.
Possible problems:
Non-zero values indicate that there is at least some level of blocking occurring. If you
combine this with the Lock Wait Time counter, you can get some idea of how long the
blocking lasted. A zero value for this counter can definitively rule out blocking as a
potential cause.
Remediation:
High Read queries should be reviewed.
Lock Definition:
Timeouts/sec This performance counter returns the number of lock requests per second that have
timed out, including internal requests for NoWait locks.
Information (timeout_period):
This is the number of milliseconds that passes before Microsoft SQL Server returns a
locking error. A value of -1 (default) indicates no time-out period (that is, wait forever).
When a wait for a lock exceeds the time-out value, an error is returned. A value of 0
means to not wait at all and return a message as soon as a lock is encountered.
Possible problems:
If you see a value above 0 for this counter, your users experience problems as their
queries are not completing.
Remediation:
You should review your queries to determine which queries are causing this situation.
781
Information:
Though this counts how many milliseconds SQL Server is waiting on locks during the
last second, this counter actually starts recording at the end of locking event. Peaks
most likely represent one large locking event.
Possible problems:
If the returned value is greater than 60 seconds (60,000ms) then there may be extended
blocking which could be an issue.
Remediation:
Thoroughly analyze the blocking script output. Some applications are written for timing
out after 60 seconds. Because SQL Server records a lock at the end of a locking event,
remember that an application with large transactions may have inflated lock wait times
while still performing as expected. For example, an application that issues multi-million
record updates might have very long lock wait times while performing exactly as it was
designed.
Average Definition:
Latch This performance counter reports the average latch wait time, in milliseconds, for latch
Wait Time requests that had to wait.
Information:
SQL Server two lightweight mutual exclusion solutions-Latches and Spinlocks-which are
less robust than locks but are less resource intensive. The value of this counter should
generally correlate to Latch Waits/sec and move up or down with it accordingly.
Possible problems:
If you see this number jump above 300, you may have contention for your server's
resources. High values for this counter could potentially block other users.
Remediation:
You should examine tasks currently waiting using the following command: sys.dm_os_
waiting_tasks DMV.
Information:
Generally speaking, the lower the value, the better. This value should correlate to
the Lock Waits/sec counter and move up or down with it accordingly.
782
Possible problems:
An average wait time longer than 500ms may indicate excessive blocking.
Remediation:
You should determine which queries are generating locks to identify where the blocking
is originating.
Information:
Short term light weight synchronization object. Latches are not held for the duration of
a transaction. Typical latching operations during row transfers to memory, controlling
modifications to row offset table, and so on.
Possible problems:
If high, check Perfmon Disk and Memory objects for:
n I/O bottlenecks
n Memory pressure
Remediation:
This can be mitigated by adding more memory or I/O capacity.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
783
Memory
This resource displays the current status of SQL Server memory. The icons of the listed performance
counters in the Statistic Name column change colors to reflect the listed counter's current state. Clicking
any performance counter in the Statistic Name column takes you to the Performance Counter Details page
for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
784
Counter Expert Knowledge
785
Total Server Definition:
Memory This performance counter measures the current amount of memory that SQL Server is
using.
Information:
If the value of this counter continues to grow larger, the server has not yet reached its
steady state and is still trying to populate the cache and get pages loaded into memory.
Performance may be somewhat slower if this value continually grows larger since more
disk I/O is required. This behavior is normal. Eventually Total Server Memory should
approximate Target Server Memory.
Possible problems:
If the Total Server Memory counter is greater than or equal to the Target Server Memory
counter, this can indicate that your SQL Server may be under memory pressure.
Remediation:
Installing additional memory into your SQL server should resolve the problem.
Target Definition:
Server This monitor measures the total amount of dynamic memory the server can consume.
Memory
Information:
This performance counter tells you how much memory SQL Server would like to use to
operate efficiently. Compare with Total Server Memory.
Possible problems:
If the Total Server Memory counter is greater than or equal to the Target Server Memory
counter, this could indicate that your SQL Server may be under memory pressure.
Remediation:
Installing additional memory into your SQL server should resolve the problem.
Target - Definition:
Total Server This performance counter shows the difference between the total amount of dynamic
Memory memory the server can consume and the current amount of memory that SQL Server is
using.
Possible problems:
If this performance counter is greater than or equal to the Target Server Memory
performance counter, this indicates that SQL Server may be under memory pressure.
Remediation:
Installing additional memory into SQL server should resolve the problem.
786
SQL Cache Definition:
Memory This performance counter measures the total amount of dynamic memory the server is
(KB) using for the Dynamic SQL cache.
Information:
Most memory used by SQL Server is allocated to the Buffer Pool, which is used to store
data pages. SQL Server steals a proportion of this memory for use in caching query
plans. The overall amount of memory available to SQL Server depends upon the amount
of memory installed on the server, the architecture of the server, the version and edition
of SQL Server and the amount of memory pressure being experienced by SQL Server.
This pressure can be internal (SQL Server resources need memory) or external (operating
system needs memory). SQL Server is designed to respond to memory pressure when
necessary.
Possible problems:
Memory contention with the buffer pool.
Remediation:
Increase memory available to SQL server.
Lock Definition:
Memory This performance counter returns the total amount of dynamic memory the server is
using for locks.
Information:
Lock pages in memory is used to prevent older versions of Windows and SQL from
allowing Windows operating system page out of the buffer pool.
Possible problems:
Lock pages in memory determines which accounts can use a process to keep data in
physical memory, which prevents the system from paging the data to virtual memory on
disk. Exercising this privilege could significantly affect system performance by
decreasing the amount of available random access memory (RAM).
Remediation:
Upgrade to Windows 2008 R2 or greater and SQL 2008 or greater.
787
Granted Definition:
Workspace This performance counter returns the total amount of memory currently granted to
Memory executing processes, such as Hash, Sort, Bulk Copy, and Index creation operations.
Information:
This performance counter tells you how much memory has currently been granted to
running queries. If there is memory pressure because of workspace memory, this value
should be at least 25% of the virtual memory available to SQL Server.
Possible problems:
If the memory pressure is severe, the server might return errors such as 701 or 8645.
Remediation:
If this is the case, this might be a good reason to consider using SQL Server 64-bit.
Optimizer Definition:
Memory This performance counter returns the total amount of dynamic memory the server is
using for query optimization.
Information:
There are no thresholds associated with this performance counter.
Connection Definition:
Memory This monitor returns the total amount of dynamic memory the server is using for
maintaining connections.
Information:
SQL Server sets aside three packet buffers for every connection made from a client. Each
buffer is sized according to the default network packet size specified by the sp_configure
stored procedure. If the default network packet size is less than 8KB, the memory for
these packets comes from SQL Server's buffer pool. If it is 8KB or larger, the memory is
allocated from SQL Server's MemToLeave region. It is worth noting that the default
network packet size for the .NET Framework Data Provider for SQL Server is 8KB, so the
buffers associated with managed code client connections typically come from SQL
Server's MemToLeave region. This contrasts with classic ADO applications, where the
default packet size is 4KB, and the buffers are allocated form the SQL Server buffer pool.
Memory Definition:
Grants This monitor returns the total number of processes waiting for a workspace memory
Pending grant.
788
Information:
Memory resources are required for each user request. If sufficient memory is not
available, the user waits until there is adequate memory for the query to run.
Possible problems:
Returned values greater than zero for a sustained period of time is a very strong
indicator of memory pressure.
Remediation:
You should first examine the database design, queries, and indexes to ensure the system
is properly tuned before installing additional RAM. There may be query inefficiencies in
the instance that is causing excessive memory grant requirements. For example, large
Sorts or Hashes that can be resolved by tuning the indexing or queries being executed.
Compare with Memory Grants Outstanding. If the number of pending grants increases,
try the following:
Memory Definition:
Grants This performance counter returns the total number of processes that have successfully
Outstanding acquired a workspace memory grant.
Information:
Look at Memory Grants Outstanding and Memory Grants Pending. If you see a long
queue of pending grants as compared to outstanding grants, there is likely memory
pressure because of query workspace memory. You can confirm this by checking the
Granted Workspace Memory (KB) performance counter that tells you how much memory
has currently been granted to running queries.
Possible problems:
A returned value that is high can indicate peak user activity. If there is memory pressure
because of workspace memory, this value should be at least 25% of the virtual memory
available to SQL Server. If the memory pressure is severe, the server might even return
errors such as 701 or 8645.
Remediation:
If severe, and using 32-bit, consider using SQL Server 64-bit. See Memory Grants
Pending.
789
Pages/sec Definition:
This performance counter displays the rate at which pages are read from or written to
disk to resolve hard page faults.
Information:
This is a primary indicator of the kinds of faults that cause system-wide delays. This
should be close to zero on a dedicated SQL Server. You will see spikes during backups
and restores, but this is normal.
Possible problems:
High values causes hard page faults, which can cause SQL Server to use the page, as
opposed to RAM.
Remediation:
You may want to add additional RAM to stop the paging.
Information:
A high percentage here means that your SQL Server is not building a new plan for every
query it is executing and is working effectively and efficiently. A low percentage here
means that, for some reason, the SQL Server is doing more work than it needs to. This
metric needs to be considered alongside the plan cache reuse metric which looks at the
spread of plan reuse through your cache.
Plan cache is memory used to store objects such as stored procedures, ad hoc and
prepared Transact-SQL statements, and triggers. The plan cache is the component of
SQL memory that stores query plans for re-use. When a query is issued against SQL, the
optimizer attempts to re-use a cached plan if the traits of the query permit - but can only
do so if that plan resides in cache, otherwise it needs to compile a new plan. This is not
to say that every plan that is cached is re-used. Changes in schema, a query running
parallel that may have run serially before, or changes in parameters may require a new
plan to be compiled even if a similar plan exists in cache. Plan compilations are
expensive though. Ideally this counter should be near 100%.
Possible problems:
The value of this counter should never fall below 90%. Low cache hit ratio (<20%) along
with a sustained query execution rate (Batch Requests/sec) indicates that compiled plans
are not being re-used. It should be noted that the hit ratio counter may be skewed by
internal lookups performed.
790
Remediation:
The amount of caching should be reduced by examining the workload to see if queries
have been parameterized, or can be rewritten with stored procedures.
Available Definition:
MBytes This is the amount of available physical memory on the server.
Information:
An acceptable output for this may vary widely based on how much physical memory is in
the machine. If you have 2GB of RAM installed on the machine, it is common to see SQL
Server use 1.7GB of RAM. If no other processes are running on your SQL Server, ensure
you have at least 80MB available for Windows at any given time.
Possible problems:
Low values show that SQL server has lack of memory.
Remediation:
Install additional memory.
Information:
A Page File is simply a file on the hard drive that handles situations where the system
wants to move or “page out” sections of memory. There are several situations that cause
this, but the one you should be most concerned about is when the system is out of
physical memory.
Possible problems:
Values greater than 70 percent indicate paging and lack of memory. If the system runs
out of memory it can “borrow” some storage from the hard drive to release some memory
until it needs that data again. The reason that this is bad is because hard drives are
amazingly slow in comparison with solid-state memory access. Using the page file slows
SQL Server a great deal.
Remediation:
Install additional memory.
Workfiles Definition:
Created/sec This is the number of work files created per second.
791
Information:
For example, work files could be used to store temporary results for hash joins and hash
aggregates. The returned value should be less than 20. Tempdb work files are used in
processing hash operations when the amount of data being processed is too large to fit
into the available memory.
Possible problems:
High values can indicate thrash in the tempdb file as well as poorly coded queries.
Remediation:
It is possible to reduce the value this monitor returns by making queries more efficient
by adding/changing indexes. Adding additional memory also helps.
Worktables Definition:
Created/sec This performance counter displays the number of work tables created per second.
Information:
For example, work tables could be used to store temporary results for query spool, lob
variables, XML variables, and cursors. The returned value should be less than 20.
Worktables are used for queries that use various spools (table spool, index spool, and so
on).
Possible problems:
High values could cause general slowdown.
Remediation:
Remediation requires rewriting your procedures.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
792
Pages
In SQL Server, the page size is 8 KB. Therefore, SQL Server databases have 128 pages per MB. Each page
starts with a 96 byte header that stores information about the page. This information includes the page
number, page type, the amount of free space on the page, and the allocation unit ID of the object that
owns the page.
The icons of the listed performance counters in the Statistic Name column change color to reflect the
listed counter's current state. Clicking any performance counter in the Statistic Name column takes you to
the Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
793
Counter Expert Knowledge
Page Definition:
Lookups/sec: This performance counter returns the number of requests to find a page in the buffer
pool.
Information:
(Page lookups/sec) / (Batch Requests/sec) > 100.
Possible problems:
When the ratio of page lookups to batch requests is much greater than 100, this is an
indication that while query plans are looking up data in the buffer pool, these plans are
inefficient.
Remediation:
Identify queries with the highest amount of logical I/O's and tune them.
Page Definition:
Reads/sec This performance counter returns the number of physical database page reads issued.
Information:
80 - 90 physical database page reads per second is normal.
Possible problems:
Returned values that are high could indicate indexing or memory constraint.
Remediation:
Attempt to tune the application so that fewer I/O operations are required. For example,
perhaps I/O operations would be reduced if there were the appropriate indexes, or if
the database design were de-normalized. If the applications cannot be tuned, you need
to acquire disk devices with more capacity. Because physical I/O operations are
expensive, you may be able to minimize the cost either by using a larger data cache,
intelligent indexes, more efficient queries, or by changing the database design.
Page Definition:
Lookups/ This performance counter displays the number of page splits per second that occur as
Batch the result of overflowing index pages.
Request
794
Information:
(Page lookups/sec) / (Batch Requests/sec) > 100.
Possible problems:
When the ratio of page lookups to batch requests is much greater than 100, this is an
indication that while query plans are looking up data in the buffer pool, these plans are
inefficient.
Remediation:
Identify queries with the highest amount of logical I/O's and tune them.
Page Definition:
Writes/sec This performance counter returns the number of physical database page writes issued.
Information:
80 - 90 physical database page writes per second is normal.
Possible problems:
If the returned values are high, you should check the Lazy Writer/sec monitor.
Page Definition:
Faults/sec This performance counter returns the average number of pages faulted per second.
Information:
This performance counter gives an idea of how many times information being
requested is not where the application expects it to be. The information must either be
retrieved from another location in memory or from the pagefile. While a sustained value
may indicate trouble, you should be more concerned with hard page faults that
represent actual reads or writes to the disk. Disk access is much slower than RAM.
Possible problems:
Any measurement higher than zero delays response time and probably indicates that
more RAM is needed.
Remediation:
Add additional memory to your SQL server.
Page Definition:
Splits/Batch This performance counter displays the number of page splits per second that occur as
Request the result of overflowing index pages.
795
Information:
The returned value needs to be low as possible.
Possible problems:
High values could mean poor table or index design.
Remediation:
If the number of page splits is high, consider increasing the Fill Factor of your indexes.
An increased Fill Factor helps to reduce page splits because there is more room in data
pages before it fills up and a page split has to occur. Note that this counter also
includes the new page allocations as well and does not necessarily pose a problem. The
other place we can confirm the page splits that involve data or index rows moves are
the fragmented indexes on page splits.
Page Definition:
Splits/sec This performance counter returns the number of page splits per second.
Information:
The returned value for this monitor should be as low as possible.
Possible problems:
Returned values that are high can indicate the overflowing of index pages. A high value
for this counter is not bad in situations where many new pages are being created, since
it includes new page allocations.
Remediation:
To avoid Page Splits, review the table and index design so as to reduce non-sequential
inserts. You can also implement Fillfactor and Pad_Index to leave more empty space per
page.
796
Information:
This performance monitor reports, on average, how long data pages are staying in the
buffer.
Possible problems:
If this value gets below 300 seconds, this is a potential indication that your SQL Server
could use more memory in order to boost performance. Consistently having pages that
stay in memory for less than that amount of time may indicate the need for more
memory.
Remediation:
Add additional memory to your SQL server.
Database Definition: This metric tells you the number of database pages that are currently being
Pages occupied in the data cache.
Information:
The higher the buffer manager Database Pages is, the less room there is for SQL Server
to cache more data pages. This means that SQL Server may have to free up data cache
pages order to make room for pages being moved in from disk to the data cache, which
can increase disk IO and hurt performance. There are no specific thresholds for this
counter as each server is different. Instead, watch baseline values and look for sudden
changes in the baseline value.
Possible problems:
If the value for this performance counter increases above its typical baseline value, this
may indicate memory pressure for the SQL Server instance.
Remediation:
Investigate buffer management and disk I/O.
Free Definition:
Memory The amount of memory available for SQL Server to use.
Note: This
performance
counter is
only available
in SQL Server
2012.
797
Information:
When SQL Server is using memory dynamically, it queries the system periodically to
determine the amount of free memory. Maintaining this free memory prevents the
operating system (OS) from paging. If less memory is free, SQL Server releases memory
to the OS. If more memory is free, SQL Server may allocate more memory. SQL Server
adds memory only when its workload requires more memory; a server at rest does not
increase the size of its virtual address space. The returned value should be as high as
possible.
Possible problems:
If Resource Semaphore does not find enough free memory, then it puts the current
query into the waiting queue.
Remediation:
l Increase RAM
l Increase SQL Server’s Max Server Memory
l Consider OS requirements and other instances
Information:
This is not main indicator of memory problems and could only used as signal of possible
memory pressure.
Possible problems:
If this performance counter is critical and other memory counters are good, it is possible
that there are no problems with memory.
Remediation:
Check other memory counters. If they have critical values, you may try to install
additional memory into SQL server.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
798
Processes and Services
This resource provides detailed information about the active processes and services associated with the
database selected. Hovering over a component gives you detailed information about that component.
799
Sessions
Sessions include both connections and internal background processes like ghost cleanup , checkpoint, and
so on. There is a close correlation between connections and sessions, but they are not necessarily the
same.
The icons of the listed performance counters in the Statistic Name column changes color to reflect the
listed counter's current state. Clicking any performance counter in the Statistic Name column takes you to
the Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
Active Definition:
Sessions A current connection that is actively processing.
800
Information:
To find information about an active session, Use Sp_Who2 Active or Sys.Dm_Exec_Sessions
(Available in SQL 2005 or greater).
Possible problems:
Blocking session.
Remediation:
Wait until blocking clears or kill the session. If killed, the process would roll back changes. If
there are many changes, it could take a while to roll-back.
Inactive Definition:
Sessions A current connection that is not currently processing.
Information:
To find information about an inactive sessions, use Sp_Who2.
Possible problems:
Blocking session.
Remediation:
Kill the session if blocking a process needs to finish. If killed, the process would roll back
changes. If there are many changes, it could take a while to roll-back.
System Definition:
Sessions A System initiated connection.
Information:
Normally these numbers are less than 50.
Possible problems:
Blocking session.
Remediation:
Do not kill system sessions.
User Definition:
Sessions A user initiated connection.
801
Information:
Normally these numbers are greater than 50.
Possible problems:
Blocking session.
Remediation:
Kill the session if blocking a process needs to finish. If killed, the process rolls back changes.
If there are many changes, it could take a while to roll-back.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
802
SQL Agent Job Status
The SQL Agent is a Microsoft Windows service that executes scheduled administrative tasks known as
"jobs" in SQL Server. This resource shows the status and details of these jobs.
SQL Agent Job information is used to provide metrics for this resource and cannot be edited.
803
SQL Errors
This resource displays SQL events that have occurred on the current SQL instance. The data can be sorted
by clicking the headers of each column.
n Date/Time: Displays the date and time that the error occurred.
n Error Message: Displays the error message that occurred at the listed date and time.
804
SQL Event Log Message Details
This resource displays the SQL event log messages while providing a search window and a filter. The filter
allows you to choose which types of log messages you want to display. The data can be sorted by clicking
the headers of each column. This resource shows only Error and Warning events specific to the monitored
SQL instance.
The filter, Information, will not list any events. This is by design and is an accidental by-product of
an earlier resource that was implemented.
Clicking any event message in the list will open a new window, displaying the entire message.
805
SQL Server
This resource shows the status of SQL server counters that warrant a view independent of grouped
resources.
The icons of the listed performance counters in the Statistic Name column changes color to reflect the
listed counter's current state. Clicking any performance counter in the Statistic Name column takes you to
the Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
806
Counter Expert Knowledge
807
Information:
The values this monitor returns generally follows in step as to how busy your
server's CPUs are. From a network bottleneck approach, a typical 100Mbs network
card is only able to handle about 3,000 batch requests per second.
Possible problems:
Generally speaking, over 1,000 batch requests per second indicates a very busy
SQL Server. If this is the case, you may soon experience a CPU bottleneck, if you
are not already. Of course, this is a relative number, and the more powerful your
hardware, the more batch requests per second your SQL Server can handle.
Remediation:
Check your SQL server and verify system resources are being used efficiently.
Applications other than SQL may be using unnecessary system resources. Try and
recover memory by closing unnecessary applications. Installing additional
memory and upgrading your hardware should solve this problem.
SQL Definition:
Compilations/sec This performance counter returns the number of times per second that SQL
Server compilations have occurred.
Information:
This value should be as low as possible.
Possible problems:
If you see a high value, say above 100, then this can be an indication that there
are a great deal of ad hoc queries that are running which may cause increased
CPU usage.
Remediation:
Re-write the running ad hoc queries as stored procedures or use the following
command: sp_executeSQL.
808
SQL Definition:
Recompilations/sec This performance counter returns the number of SQL statement recompiles that
are triggered per second.
Information:
When an execution plan is invalidated due to some significant event, SQL Server
re-compiles it. Re-compiles like compiles, are expensive operations so you want to
minimize the number of re-compiles. Ideally you want to keep this counter less
than 10% of the number of Compilations/Sec. In other words, keep this value as
low a possible.
In SQL Server 2000, when SQL Server recompiles a stored procedure, the entire
stored procedure is recompiled, not just the statement that triggered the
recompilation. In SQL Server 2008 and SQL Server 2005 SP3, the behavior is
changed to statement-level recompilation of stored procedures. When SQL Server
2008 or SQL Server 2005 SP3 recompiles stored procedures, only the statement
that caused the recompilation is compiled, not the entire procedure. This uses
less CPU bandwidth and results in less contention on lock resources such
as Compile locks.
Possible problems:
Returned values that are high can indicate deadlocks and compile locks that are
not compatible with any locking type.
Remediation:
Recompilation can happen for various reasons, such as: Schema changed;
Statistics changed; Deferred compile; Set option changed; Temporary table
changed; Stored procedure created with the Recompile query hint or using
the Option (Recompile).
809
n Another option is to use the Keep Plan query hint. This sets the threshold of
temporary tables to be the same as that of permanent tables.
The EventSubclass column indicates that “Statistics Changed” for an
operation on a temporary table.
n To avoid recompilations that are due to changes in statistics (for example,
when the plan becomes suboptimal due to change in the data statistics),
specify the KeepFixed Plan query hint. With this option in effect,
recompilations can only happen because of correctness-related reasons (for
example, when the underlying table structure has changed and the plan no
longer applies) and not due to statistics. An example might be when a
recompilation occurs if the schema of a table that is referenced by a
statement changes, or if a table is marked with the sp_recompile stored
procedure.
n Turning off the automatic updates of statistics for indexes and statistics
that are defined on a table or indexed view prevents recompiles that are
due to statistics changes on that object. Note, however, that turning off
the Auto-Stats feature by using this method is usually not a good idea. This
is because the query optimizer is no longer sensitive to data changes in
those objects and suboptimal query plans might result. Use this method
only as a last resort after exhausting all other alternatives.
n Batches should have qualified object names (for example, dbo.Table1) to
avoid recompilation and to avoid ambiguity between objects.
n To avoid recompiles that are due to deferred compiles, do not
interleave DML and DDL or create the DDL from conditional constructs such
as If statements.
n Run Database Engine Tuning Advisor (DTA) to see if any indexing changes
improve the compile time and the execution time of the query.
n Check to see if the stored procedure was created with the With
Recompile option or if the Recompile query hint was used. If a procedure
was created with the With Recompile option, in SQL Server 2005 SP3, you
may be able to take advantage of the statement level Recompile hint if a
particular statement within that procedure needs to be recompiled. This
would avoid the necessity of recompiling the whole procedure each time it
executes, while at the same time allowing the individual statement to be
compiled.
Auto-Param Definition:
Attempts/sec: This monitor returns the number of auto- parameterization attempts per second.
810
Information:
The total for this monitor should be the sum of the failed, safe, and unsafe auto-
parameterizations. Auto-parameterization occurs when an instance of SQL Server
tries to parameterize a Transact-SQL request by replacing some literals with
parameters so that reuse of the resulting cached execution plan across multiple
similar-looking requests is possible. Note that auto-parameterizations are also
known as simple parameterizations in newer versions of SQL Server. This counter
does not include forced parameterizations.
Possible problems:
Bad T-SQL coding practices can increase recompilation frequency and adversely
affect SQL Server's performance. Such situations can be debugged and corrected
in many cases.
Longest Definition:
Transaction The performance counter displays the length of time, in seconds, the transaction
Running Time that has been running the longest, has been active.
Information:
Transactions that run longer than others use more resources. They can be used
to track down procedures and calls that are taking longer than expected by
identifying the specific transaction(s).
Possible problems:
Long running transactions can prevent truncation of transaction logs. This can
cause the transaction log files to grow until they consume all available physical
disk space shutting down access to the database.
Remediation:
Check the functionality of the query and/or redesign the long running
transaction.
Possible problems:
Bad T-SQL coding practices can increase recompilation frequency and adversely
affect SQL Server's performance. Such situations can be debugged and corrected
in many cases.
811
Full Scans/sec Definition:
This performance counter returns the number of Full Scans on base tables or
indexes.
Information:
This is the number of unrestricted full scans per second. These can be either
base-table or full-index scans.
Possible problems:
Values greater than 1 or 2 indicate table/Index page scans are occurring. If the
CPU is running high, you should investigate the cause as related to this counter
measurement. You can rule this out as a problem if the full scans are on small
tables.
Remediation:
Following are a few of the main causes of high Full Scans/sec:
n Missing indexes
n Too many rows requested; Queries with missing indexes or too many rows
requested have a large number of logical reads and an increased CPU time.
n Scans are IO-intensive and should run within your databases minimally.
Identify the tables that have a large number of scans against them. Review
the fill factor you have set up on your indexes and minimize it where
appropriate.
Information:
This monitor returns the number of qualified range scans through indexes per
second.
812
Possible problems:
Zero cost plans are not be cached (not re-used) in SQL 2005 SP2. Applications that
use zero cost plans have a lower plan re-use but this is not a performance issue.
Remediation:
Review your plan re-use design. Tune your plan re-use design as it is described in
the following article: http://sqlmag.com/sql-server/fine-tuning-plan-reuse.
Information:
There are no thresholds associated with this performance counter.
Recompilations/ Definition:
Compilations This performance counter shows the ratio of SQL Recompilations to SQL
Compilations.
Information:
SQL Recompilations should be less than 10% of SQL Compilations.
Possible problems:
Returned values that are high can indicate more temporary tables in use.
Remediation:
Change stored procedures to not change schemas, Use table variables instead of
temporary tables
Compilations/ Definition:
Recompilations/sec Monitoring the number of query compilations and recompilations and the
number of batches received by an instance of SQL Server gives you an indication
of how quickly SQL Server is processing user queries and how effectively the
query optimizer is processing the queries.
Information:
Compilation is a significant part of a query's turnaround time. In order to save the
compilation cost, the Database Engine saves the compiled query plan in a query
cache. The objective of the cache is to reduce compilation by storing compiled
queries for later reuse, therefore ending the requirement to recompile queries
when later executed. However, each unique query must be compiled at least one
time.
813
Possible problems:
Query recompilations can be caused by the following factors:
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
814
Top 10 Databases by Active User Connections
This resource graphically shows the number of users per database for the top 10 most active databases.
The colors of the chart correspond to the labels in the legend, which indicate the most active databases.
The performance counter, Top Active Sessions with Statistics, is used to provide metrics for this
resource and cannot be edited.
Expanding the tree by clicking [+] will provide details about the users, host, length of connection
and idle time, as well as the number of bytes transferred during that time.
815
Top 10 Most Expensive Queries by CPU Time
This resource displays the top 10 most expensive queries sorted by the length of time the CPU spent
processing the listed query.
When viewing this resource from the Summary tab on the Application Details page, queries are listed for
the entire SQL Server instance. Conversely, when this same resource appears on the Database Details
view, queries are only listed for that specific database.
The data can be sorted by clicking the headers of each column. Additionally, this resource can optionally
show Top Queries by I/O by clicking Edit in this resource and making the necessary adjustments.
The resource is filtered based on the settings found on the Queries tab in Details view in the Most
Expensive Queries resource.
n Query Text: The text shown is a preview of the full query. To view an entire query in the list, click [+]
next to the query listed to expand and view the query.
Note: Clicking any listed query takes you to the Most Expensive Queries resource on the Queries tab,
providing greater detail about the query.
n CPU Time: Display the time, in milliseconds, the listed query took to complete.
n Database: Displays the database with which the listed query is associated. The icon in this column
shows the current state of the listed database.
816
The performance counter, Top Expensive Queries, is used to provide metrics for this resource and
cannot be edited.
817
AppInsight for SQL Details View
The Queries tab provides detailed insight into the most expensive queries running on your SQL instance.
The performance counter, Top Expensive Queries, is used to provide metrics for this resource and
cannot be edited.
818
Most Expensive Queries
This resource provides detailed insight into the most expensive queries running on your SQL database.
Queries for this view can be filtered by Time, Host, Database, and Login using the filter drop down menus
at the top of the window.
The filters used here are also be applied to the Top 10 Most Expensive Queries by CPU Time
resource found on the Summary tab in the Details view.
To view an entire query in the list, hover the mouse over a query, or click [+] next to the query listed to
expand and view the query.
n Query Text: The text shown is a preview of the full query. To view an entire query in the list, click [+]
next to the query listed to expand and view the query.
n SPID: Server Process ID of the listed query.
n Plan Count: Displays the number of cached query plans for the listed query. A large number might
indicate a need for explicit query parameterization.
n Executions: Displays the number of times the listed query was executed.
n CPU Time: Displays the amount of time, in milliseconds, that the listed query took to complete.
n Phys. Read: This field returns the number of physical reads. Physical reads are reads that require
reading directly from disk. Physical reads are substantially slower than reading from the cache or
from RAM.
n Logical Reads: Displays the number of times data was read from the cache.
n Logical Writes: Displays the number of times data was written to the cache.
819
n Average Duration: This displays the length of time it took, in milliseconds, to execute the listed
query averaged by the number of executions.
n Bytes Transferred: Number of bytes transferred during the query.
n Login: Displays the current login information for the listed database.
n Host: Displays the host for the listed database.
n Database: Displays the current name for the listed database. Clicking any database in the list will
take you to the Database Details page.
820
Database Details View
The Database Details view provides a great deal of information about the current database and can be
accessed by clicking any listed database.
Important: A high number of databases monitored on a single SQL instance using AppInsight for
SQL can cause job timeout issues. To alleviate this problem, try increasing the timeout value. If this
does not resolve the issue, reduce the number of visible databases by granting view permissions to
the user account used for polling only for the databases you want to see.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click to the AppInsight for SQL Details view.
2. From the All Databases resource, click any database in the list.
821
Active User Connections
This resource provides detailed information about the active user connections associated with the
database selected. Data can be sorted by clicking the headers of each column.
n Login: This displays the login information for the listed user connection.
n Host: This displays the type of host associated with the listed user connection.
n Connection Duration: This displays the length of time the listed user connection has been
connected.
n Idle Time: This displays the length of time the listed user connection has been idle.
n Bytes Transferred: This displays the number of bytes transferred for the listed user connection.
The performance counter, Top Active Sessions with Statistics, is used to provide metrics for this resource
and cannot be edited.
822
Connections
This resource shows the status of your current database connections. The icons of the listed performance
counters in the Statistic Name column change colors to reflect the listed counter's current state. Clicking
any performance counter in the Statistic Name column takes you to the Performance Counter Details page
for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
User Definition:
Connections The User Connections performance counter identifies the number of different users
that are connected to your SQL Server at the time the sample was taken.
Information:
823
You need to watch this performance counter over time to understand your baseline user
connection numbers. Since each user connection consumes some memory space, a high
number of user connections can impact throughput and cause a performance slow-
down. Once you have an idea of your high and low thresholds during normal usage of
your system, you can then look for times when this counter exceeds these high and low
marks.
Possible problems:
If the returned value of this performance counter goes down and the load on the system
remains stable, you might have a bottleneck that is not allowing your server to handle
the normal load. Keep in mind that this counter value might go down just because less
people are using your SQL Server instance. If you see this number jump by 500% from
your baseline, you may be seeing a slowdown of your server activity.
Remediation:
You may want to boost the SQL Server configuration setting, Maximum Worker Threads
to a figure higher than the default setting of 255. The setting for Maximum Worker
Threads should be higher than the maximum number of user connections your server
ever reaches.
Logins/sec Definition:
This performance counter returns the total number of logins started, per second, and
does not include pooled connections.
Information:
Opening and closing connections is an expensive process. A pooled connection is one
which is kept open by an application for other requests to re-use.
Possible problems:
If the returned value is high, this can indicate that the application is not correctly using
connection pooling.
Remediation:
Review the Connection Polling configuration.
Logout/sec Definition:
This performance counter returns the total number of logout operations started, per
second.
824
Information:
Opening and closing connections is an expensive process. When applications do not use
a connection pool, each request needs to establish its own connection before the query
can be executed. It then has to close it. A pooled connection is one which is kept open
by an application for other requests to re-use.
Possible problems:
If the returned value is high, this can indicate that the application is not correctly using
connection pooling.
Remediation:
Review the Connection Polling configuration.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
825
Database Availability
This resource graphically shows the various states of availability for the current database in a percentage
format. This chart is made up of three sections: the legend, the main chart, and the lower chart. The colors
of the main chart correspond to the labels in the legend.
Clicking Edit lets you change the default zoom range, the amount of historical data loaded, and set the
sample interval time period, as well as reveal the Advanced section. Expanding the Advanced section lets
you to change the defaults of the titles from macros to anything you want.
Zooming
You can have the chart show a predetermined, hourly time period of data by clicking on any one of the
three Zoom buttons; 1h, 12h, or 24h. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart.
826
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over.
827
Database Details
This resource provides tools and details concerning the current database.
n Management: This provides tools allowing you to more easily manage and troubleshoot the current
application.
n Database Name: Displays the name of the current database.
n Performance Status: Displays the status of the current database.
n Operational State: Displays whether or not the database is currently online.
n Recovery Model: Displays the type of recovery model employed on the listed database. This can be
either, Simple, Full, or Bulk-Logged. For more information, refer to the following MSDN article:
http://msdn.microsoft.com/en-us/library/ms175987(v=sql.105).aspx
n Collation: Displays the method of sorting used by the database. (In the above image, Latin1 means
the server treats strings using Charset Latin 1, i.e. ASCII. CI means Case Insensitive. AS means Accent
Sensitive ('ü' does not equal 'u')).
828
n Compatibility Level: Displays the compatibility level of the current database. The value displayed in
this field correlates to the bulleted table below:
n 60 = SQL Server 6.0
n 65 = SQL Server 6.5
n 70 = SQL Server 7.0
n 80 = SQL Server 2000
n 90 = SQL Server 2005
n 100 = SQL Server 2008
n 110 = SQL Server 2012
n Last Backup: Displays the date and time of the last successful backup for the current database.
n High Availability Group: Displays the database mirroring status and details of the mirrored
database, if available.
829
Database Disk I/O
This resource displays the status, as well as I/O metrics, for your current database file. The icons of the
listed performance counters in the Statistic Name column change to reflect the listed counter's current
state. Clicking any volume in the Volume column takes you to the Volume Details page for that counter.
The performance counter, Database Files, is used to provide metrics for this resource. It is used in
combination with volume polling. This counter is not listed in the resource; however, the thresholds can be
changed.
830
Database Size by File
This resource lists the current databases sorted by file size. Moving the mouse over the Database Usage
percent value reveals a tooltip with more detailed information about that database. Clicking the value
takes you to the Custom Chart resource page. If the Warning or Critical thresholds is breached, the color of
the bar chart changes from green to yellow or red, respectively.
Database Files is used to provide metrics for this resource. This counter is not listed in the resource;
however, the thresholds can be changed.
831
Log Flushes
This resource contains monitors specific to the current status of log flushes for the current database. The
icons of the listed performance counters in the Statistic Name column change colors to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you to the
Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Information:
The value returned helps identify trends of the transaction log. A log flush happens when
data is written from the log cache to the transaction log on disk, each time a transaction
happens.
832
Possible problems:
The rate at which log records are written to the disk. This is the log generation rate of the
application. It plays a very important role in determining database mirroring
performance. This counter is in the Databases performance object.
Log Bytes Flushed/sec can indicate many small transactions leading to high mechanical
disk activity.
Remediation:
Look at the statements associated with the log flush and determine if the number of log
flushes can be reduced. When a single transaction is used, the log records for the
transaction can be bundled and a single, larger write can be used to flush the gathered
log records. The mechanical intervention is significantly reduced. It is not recommended
that you increase your transaction scope. Long-running transactions can lead to excessive
and unwanted blocking as well as increased overhead.
Log Definition:
Flushes/sec This performance counter returns the number of log flushes per second, averaged since
the last collection time.
Information:
A log flush happens when a transaction is committed and data is written from the log
cache to the transaction log file. The log cache is a location in memory where SQL Server
stores data to be written to the log file. This is used to roll back a transaction before it is
committed. Once complete, the log cache is flushed to the physical log file on the disk.
Generally speaking, log flushes per second should parallel the number of transactions
per second.
Possible problems:
If the returned value is higher than expected, check your use of explicit transactions in
your queries.
Remediation:
Explicitly define the start and end of your transactions. This should reduce the number of
log flushes, and reduce the impact on I/O. Also check the Log Bytes Flushed/Sec monitor.
Information:
This value should be as low as possible.
Possible problems:
A high number of Log Flush Waits can indicate that it is taking longer than normal to flush
the transaction log cache. This slows the performance of your SQL Server.
833
Remediation:
Check the value of the Disk avg. Write time monitor. If the returned value is greater than
5ms, then this can indicate that there is an I/O bottleneck. Move your transaction log file
to a disk drive separate from your data files. This should increase performance since
there is no access competition on the same disk. Consider upgrading to RAID 10 for
transaction log storage. Also, adding spindles to your RAID array should increase
performance.
Information:
On an AlwaysOn secondary database, this value indicates the wait time for log records to
be hardened to disk.
Information:
This is the size of the transaction log that actively contains data in relation to the total
physical size on disk of the log file.
Possible problems:
If the log file is 100% used, it attempts to increase its size. If there is not sufficient disk
space to accommodate the growth, the database stops functioning.
Remediation:
Perform a transaction log backup to truncate the log.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
834
Storage
This resource contains monitors specific to the current storage status of the current database. The icons of
the listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
835
Counter Expert Knowledge
Backup/ Definition:
Restore This performance counter shows the Read/Write throughput for backup and restore
Throughput/sec operations of a database per second.
Information:
836
You can measure how the performance of the database backup operation changes
when more backup devices are used in parallel, or when faster devices are used.
Throughput of a database backup or restore operation allows you to determine the
progress and performance of your backup and restore operations. There are no
thresholds associated with this performance counter.
Possible problems:
Running out of storage space.
Remediation:
Shrink the database if free space is running low.
Information:
Every transaction in the database is logged to the Transaction log. This is useful
during recovery in the event of data loss. Information about the log file is shown
under the Files section of the Database Overview page in SQL Server Management
Studio.
The size of this file is based on the logging level set for the database. By default, a
new database uses Full Recovery Mode or the recovery mode that the model
database is set up as. Transactions in the log file are only removed when a complete
backup or transaction log backup is initiated. This enables pinpoint recovery for
critical applications. Be aware that if the transaction log is not backed up on a
regular basis, the log grows until your disk is completely full. The transaction log
should be adjusted to a reasonable size. This depends on the number of
transactions you expect, and how often you perform backups.
Set the correct Autogrowth properties: The default of 10% Autogrowth for data and
log files should be enough for low use databases. Conversely, a 500 MB Autogrowth
rate may be better suited for a busy database, preventing a large I/O impact caused
by normal Autogrowth operations.
837
Possible problems:
If the returned value occasionally drops to zero, this can indicate a problem with the
following file: sys.master_files. This file is what the SQL Monitor uses to collect data.
Note: With Simple Recovery Model, fast writing to the transaction log triggers
Autogrowth.
Remediation:
If you are performing a insert operation, you should consider switching the recovery
model to Bulk Logged for the insert.
Note: This action removes inactive virtual log files, but does not reduce the file size.
Information:
Monitoring this counter is useful for determining the correct size of tempdb. The
value returned from this monitor reports the size of your database (not including
the Transaction log). Information about distinct primary data files and secondary
data files is shown under the Files section of the Database Overview page in SQL
Server Management Studio.
Possible problems:
Be wary of large and unusual increases to the size of your data files. Generally
speaking, your database should be sized to minimize Autogrowth. An increase in
size is expensive concerning I/O. Additionally, this fragments your data and log files.
If the returned value occasionally drops to zero, this can indicate a problem with the
following file: sys.master_files. This file is what the SQL Monitor uses to collect data.
Remediation:
n Ensure that Full Recovery Mode is used for your databases and that you
regularly backup everything, including the transaction log.
838
n Manually add space as data increases in size. It is recommended that you
have approximately one year of space available for data growth. If this is not
possible, move the database to a higher capacity drive or simply upgrade the
drive.
Note: Compressing files causes fragmentation and is therefore not
recommended.
Information:
Shrinking data files recovers space by moving pages of data from the end of the file
to unoccupied space closer to the front of the file. When enough free space is
created at the end of the file, data pages at end of the file can de-allocated and
returned to the file system.
Possible problems:
Data that is moved to shrink a file can be scattered to any available location in the
file. This causes index fragmentation and can slow the performance of queries that
search a range of the index.
Remediation:
To eliminate the fragmentation, consider rebuilding the indexes on the file after
shrinking.
Average Definition:
Bytes/Read Perfmon captures the total number of bytes sent to the disk (write) and retrieved
from the disk (read) over a period of one second.
Information:
The Disk Read Bytes/sec and the Disk Write Bytes/sec performance counters break
down the results displaying only read bytes or only write bytes, respectively.
Average Definition:
Bytes/Write Perfmon captures the total number of bytes sent to the disk (write) and retrieved
from the disk (read) over a period of one second.
Information:
The Disk Read Bytes/sec and the Disk Write Bytes/sec performance counters break
down the results displaying only read bytes or only write bytes, respectively.
839
Information:
The average read latency should be less than 20ms for database files.
Information:
This analysis determines if any of the physical disks are responding slowly.
Possible problems:
If the response times are greater than .015 (15 milliseconds), then the disk
subsystem is keeping up with demand, but does not have much overhead left.
If the response times are greater than .025 (25 milliseconds), then noticeable slow-
downs and performance issues affecting users may be occurring.
Forwarded Definition:
Records/sec This performance counter returns the number of records per second fetched
through forwarded record pointers.
Information:
Heaps have one interesting feature - forwarded records. If a record needs to be
updated and the updated record size is greater than the current record size, and
there is no space on the page to fit the new record in, then we have two options:
1. Move the record to a new page and change all the non-clustered index
records that point to it to point to the new location of the record.
2. Move the record to a new page and leave a forwarding record in the original
location to point to the new location.
Possible problems:
This is one drawback of using heaps - all the extra space that is wasted with the
Forwarding/Forwarded Records. Another drawback is that when scanning through
the heap, forwarding records have to be followed immediately (as opposed to
ignoring them and just reading the forwarded records when they are encountered).
This is to vastly reduce the possibility of read anomalies such as non-repeatable
reads or missed rows if a row moves before the scan point during a scan.
Remediation:
Once a data table (heap) includes forward pointers, there is only one way to get rid
of them : Table Reorg. There are a few options to do this:
n The simplest one would be to create a clustered index on the data table and
drop it again.
840
n To avoid forward pointers entirely, create a clustered index from the
beginning. A clustered index keeps the data rows in its leaf node level.
Therefore the data is always sorted according to the index keys and forward
pointers are not used. This is like a continuous online Reorg in this regard.
Information:
The log cache is used to hold information that is written to the transaction log. There
are no thresholds associated with this performance counter.
Number of Definition:
Reads/sec This performance counter returns the number of physical database page reads
issued per second.
Information:
This statistic displays the total number of physical page reads across all databases.
80 to 90 per second is normal. Anything that is above 90 indicates indexing or
memory constraint.
Possible problems:
Because physical I/O is expensive, you may be able to minimize the cost, either by
using a larger data cache, intelligent indexes, and more efficient queries, or by
changing the database design.
Remediation:
Attempt to tune the application so that fewer I/O operations are required. For
example, perhaps I/O would be reduced if there were appropriate indexes or if the
database design were de-normalized. If the applications cannot be tuned, you need
to acquire disk devices with more capacity. Compare to the Memory: Pages/sec
performance counter to see if there is paging while the SQL Server:Buffer
Manager\Page reads/sec is high. Note: Before adjusting the fill factor, at a database
level, compare the SQL Server:Buffer Manager\Page reads/sec performance counter
to the SQL Server:Buffer Manager\Page writes/sec counter, and use the fill factor
option only if writes are a substantial fraction of reads (greater than 30 percent).
841
Number of Definition:
Writes/sec This performance counter returns the number of data pages written per second.
Information:
Page writes per second are the total number of physical writes, including checkpoint
writes, lazy writer writes, and large block writes done during index creation or bulk
copy operations.
Possible problems:
If Page Writes/sec is high, this might indicate a SQL Server performance issue.
Remediation:
If these values are high, you can try to reduce the values by tuning your application
or database to reduce I/O operations such as index coverage, better indexes,
normalization, increasing the I/O capacity of the hardware, or by adding memory.
Information:
This metric allows users to be alerted when the database experiences sudden
growth.
Possible problems:
A database that suddenly changes in size by a high percentage could be indicative
of a problem that should be investigated.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
842
Top 10 Clustered Indexes by Fragmentation
A clustered index determines the physical order of data in a table. This resource displays the clustered
indexes with the highest level of fragmentation. If the Warning or Critical threshold is breached, the color
of the bar chart changes from green to yellow or red, respectively.
The performance counter, Top Indexes for Database, is used to provide metrics for this resource. This
counter is not listed in the resource; however, the thresholds can be changed.
You may need to log in with an administrator account to perform these actions.
a. On the web console, navigate to Settings > All Settings > SAM Settings > Manage Templates.
b. Check the AppInsight for SQL application and click Edit in the toolbar.
c. Expand the Top Indexes for Database component monitor by clicking [+].
843
d. Change the value for the field, Number of Records to Retrieve and then click Submit.
844
Top 10 Most Expensive Queries by CPU Time
This resource displays the top 10 most expensive queries sorted by the length of time the CPU spent
processing the listed query.
When viewing this resource from the Summary tab on the Application Details page, queries are listed for
the entire SQL Server instance. Conversely, when this same resource appears on the Database Details
view, queries are only listed for that specific database.
The data can be sorted by clicking the headers of each column. Additionally, this resource can optionally
show Top Queries by I/O by clicking Edit in this resource and making the necessary adjustments.
The resource is filtered based on the settings found on the Queries tab in Details view in the Most
Expensive Queries resource.
n Query Text: The text shown is a preview of the full query. To view an entire query in the list, click [+]
next to the query listed to expand and view the query.
Note: Clicking any listed query takes you to the Most Expensive Queries resource on the Queries tab,
providing greater detail about the query.
n CPU Time: Display the time, in milliseconds, the listed query took to complete.
n Database: Displays the database with which the listed query is associated. The icon in this column
shows the current state of the listed database.
845
The performance counter, Top Expensive Queries, is used to provide metrics for this resource and
cannot be edited.
846
Top 10 Nonclustered Indexes by Fragmentation
A non-clustered index is one in which the data rows are not sorted and stored in order based on their non-
clustered keys. This resource displays the non-clustered indexes with the highest level of fragmentation. If
the Warning or Critical thresholds is breached, the color of the bar chart changes from green to yellow or
red, respectively.
The performance counter, Top Indexes for Database, is used to provide metrics for this resource. This
counter is not listed in the resource; however, the thresholds can be changed.
You may need to log in with an administrator account to perform these actions.
3. Click Override Template and adjust the thresholds to suit your needs.
4. When done, click Submit.
847
Change the number of tables displayed in this resource, values must be changed in two locations
1. In the resource, click Edit, then change the value for the field: Maximum Number of Records to
Display, and then click Submit.
2. Edit the application or the template that the application is based on. To edit the template which
affect applications based on it:
a. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
b. Check the AppInsight for SQL application and click Edit in the toolbar.
c. Expand the Top Indexes for Database component monitor by clicking [+].
d. Change the value for the field, Number of Records to Retrieve and then click Submit.
848
Top 10 Tables by Size
This resource displays the current database tables in order based on size. If the Warning or Critical
thresholds is breached, the color of the bar chart changes from green to yellow or red, respectively.
n Name: Displays the name of the listed table of the current database.
n Size: Displays the size of the listed table of the current database.
n % Used by Index: Displays the percentage of the table space used by the index.
n Total Row Count: Displays the total number of rows in the listed table of the current database.
The performance counter, Top Tables for Database, is used to provide metrics for this resource. This
counter is not listed in the resource; however, the thresholds can be changed.
849
Transaction Log Disk I/O
This resource lists the current status of the transaction log file. The icons of the Volume column changes to
reflect the listed volume's current state. Clicking the volume takes you to the Volume Details page.
n File Path: Displays the full path where the transaction log file resides.
n Volume: Displays the volume where the transaction log file resides. Clicking on the volume name
takes you to the Volume Details View.
n Disk Queue Length: Displays the current disk queue length for the listed volume as seen on the
Volume Details view. Queue lengths that are high for a sustained period of time are indicative of disk
I/O performance issues that can negatively impact the database.
n Total IOPS: Displays the current total read and write IO operations occurring on the drive where the
database or transaction log file resides. High I/O may be normal for some databases, but excessively
high I/O leads to higher queue lengths, meaning there are more requests for disk reads or writes
than the storage subsystem can handle.
n Latency: Displays a measurement of disk latency occurring on the disk where the database or
transaction log file resides. High volume latency values indicate sluggish database performance.
The performance counter, Database Files, is used to provide metrics for this resource. It is used in
combination with volume polling. This counter is not listed in the resource; however, the thresholds can be
changed.
850
Transaction Log Size by File
This resource lists the current status of transaction log files as sorted by size. Hovering the mouse over a
listed percentage reveals a tooltip with detailed information about the item listed. Clicking the percentage
takes you to the Database Details page. If the Warning or Critical thresholds is breached, the color of the
bar chart changes from green to yellow or red, respectively.
n File Path: Displays the complete file path of the listed transaction log.
n Auto-Growth: Displays the current Auto-growth setting.
n File Size: Displays the current size of the listed transaction log.
n Database Usage: This resource displays the amount of space consumed as a percentage of
whatever restrictions are in place for the file. For example:
n If the transaction log is allowed to grow unrestricted, then it is limited only by the amount of
free space on the volume.
n If the transaction log is allowed to grow to a maximum size, the percentage is calculated based
on this restricted size limit.
n If the transaction log has a fixed size, the percentage used is calculated based on the total size
of the transaction log file and the amount of remaining white space.
n Volume Usage: Displays the amount of space the listed file is consuming on the volume where it is
located.
The performance counter, Database Files, is used to provide metrics for this resource. This counter is not
listed in the resource; however, the thresholds can be changed.
851
Transactions
A transaction is a unit of work that is performed against a database. In other words, if you are creating a
record, for example, then you are performing transaction on the table. It is important to control
transactions to ensure data integrity and to handle database errors.
This resource contains monitors specific to the current status of transactions. The icons of the listed
performance counters in the Statistic Name column changes color to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
Longest Definition:
Transaction This performance counter displays the length of time, in seconds, the transaction that
Running has been running the longest, has been active.
Time
852
Information:
Transactions that run longer than others use more resources. They can be used to track
down procedures and calls that are taking longer than expected by identifying the
specific transaction(s).
Possible problems:
Long running transactions can prevent truncation of transaction logs. This can cause
the transaction log files to grow until they consume all available physical disk space
shutting down access to the database.
Remediation:
Check the functionality of the query and/or redesign the long running transaction.
Transactions/ Definition:
sec This performance counter returns the number of transactions started for the database,
per second.
Information:
Transaction rate is affected by general system performance and resource constraints,
such as I/O, number of users, cache size, and the complexity of requests.
Possible problems:
A high rate of transactions can indicate that some transactions are not completing.
Remediation:
Using stored procedures in transactions speeds transaction processing because SQL
code in stored procedures runs locally on the server. The transactions can finish much
faster without the network traffic required by the transactions.
Active Definition:
Transactions This performance counter returns the number of active transactions for the database.
Information:
During an active transaction, no other transaction can modify the data held by the
active transaction. While you are modifying data, an exclusive lock is held on that data.
Conversely, you cannot read data held by another transaction because another
transaction holds an exclusive lock on the data that prevents it from being read. The
returned value for this monitor should be less than 200.
Possible problems:
A high number of active transactions can indicate that certain transactions are never
completing.
Remediation:
Keeping a low level of active transactions assists in keeping requested data accessible.
853
Repl. Trans. Definition:
Rate This performance counter returns the number of transactions read out of the
transaction log and sent to the distribution database
(Replication
Information:
Transactions
SQL Server Overall Replication Performance Analysis provides a graph of several SQL
Rate)
Server overall replication performance counters for the specified server during the
specified time period. Performance counter data is averaged by the hour. The graph
displays the following replication performance counters:
Information:
Measure the number of rows coming into the database. Optimization yields a higher
number. See The Data Loading Performance Guide http://technet.microsoft.com/en-
us/library/dd425070(v=SQL.100).aspx
Possible problems:
BCP to bulk load data over the network, having the correct throughput configured is
crucial.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
854
AppInsight for SQL alerts
View Alerts
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > Manage Alerts.
2. Select the alerts you want to view from the list, or type a keyword in the text box and click Search.
855
AppInsight for IIS
AppInsight for IIS is considered a template until it is applied. Therefore, it is a member of the Application
Monitor Templates collection. Once applied to a node, AppInsight for IIS is considered an application. Like
any SAM application, AppInsight for IIS is comprised of multiple component monitors.
The following reports are installed for use with AppInsight for IIS:
856
Understand the AppInsight for IIS Details View
The AppInsight for IIS Details view is the equivalent of the Application Details view of a traditional SAM
application; however, there are some notable differences:
n Site Details View: This view displays an overview of a particular site being monitored.
n Application Pool Details View: This view displays details about the selected application pool.
From the AppInsight for IIS Details view, you can select from the drop down menu and choose to display
different amounts of data based on a time range.
Editing Resources
Both the titles and subtitles of each resource can be changed by clicking Edit in the upper right-hand
corner of any resource, and then clicking Submit.
Additionally, certain resources will allow you to add and remove component monitors from the resource.
You can do this by clicking the Edit button, and then checking the component monitors you want to keep.
857
Alerts and reports for AppInsight for IIS
The following three alerts and their macros/variables are included with AppInsight for IIS:
Alert Description This alert restarts any failed IIS application pool that is configured to be
"AlwaysRunning." As configured, this alert will not trigger for application pools that
are configured to start "OnDemand," as these application pools stop normally when
not in use, or when the site that is configured to use the Application Pool has no
activity and is dormant.
Alert Trigger IIS application pool = Stopped and application pool startup mode is configured for
"AlwaysRunning" and Application Pool is not equal to Unmanaged.
Trigger Action Start application pool (Note: Application Pool trigger actions should include Stop,
Start, and Restart, no differently than the actions available through the Orion web
interface for AppInsight for IIS application pools.)
<br/>
<br/>
${N=SwisEntity;M=DetailsUrl}
858
<br/>
<br/>
${N=SwisEntity;M=DetailsUrl}
Alert Description This alert attempts to restart any site that is monitored by AppInsight for IIS that is
found to be in a Stopped state.
Trigger Action Start IIS site (Note: IIS site trigger actions should include Stop, Start, and Restart, no
differently than the actions available through the Orion web interface for AppInsight
for IIS sites.
<br/>
<br/>
${N=SwisEntity;M=DetailsUrl}
859
<br/>
<br/>
${N=SwisEntity;M=DetailsUrl}.
3. Alert Name Alert me when the Average Server Execution Time for any URL exceeds an
acceptable limit.
Alert This alert notifies you when the execution time of any URL monitored by AppInsight
Description for IIS exceeds a predefined acceptable limit.
Alert Trigger Average URL Server Execution Time is greater than 5 minutes.
URL: ${N=SwisEntity;M=URLStem}
860
AppInsight for IIS Application Details View
The IIS Details view provides a great deal of information about the current IIS Application. The available
resources offered in this view include:
This resource is only shown when AppInsight for IIS is being polled via an Agent. It does not appear if the
node is being polled via SNMP or WMI. For more information, see Agents.
Chart resources may not display data until multiple successful polls have completed.
861
Active Alerts
862
Application Availability
This resource graphically shows the various states of an application's availability in a percentage format
and is made up of three sections: the legend, the main chart, and the lower chart. The colors of the main
chart correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific time range by dragging the mouse over a
small area of the chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over. By default, all statistics are shown in the main chart.
863
Application Details
This resource provides details concerning the current application. You can click on both the application
and the node to be taken to their respective details page.
n Application Name: Displays the name of the listed application, in addition to the node on which it
resides.
n Status: Displays the current status of the listed application. Possible statuses include: Up, Down,
Warning, Critical, Unknown, Unreachable, and Unmanaged.
n IIS Version: Displays the current version information of IIS currently being monitored.
Note: The following three fields are tied together as components with polling issues and are
displayed in the Application Details resource.
n Component Name: Displays the component name along with its current status as indicated
by the icon.
n Component Type: Displays the information about the current component.
n Component Status: Displays the current status of the listed component.
864
Application Pools
This resource shows the status of all monitored application pools for the current IIS application. The data
can be sorted by clicking the headers of each column.
n Name: Displays the name of the listed application pool, in addition to the current performance
status as indicated by the icon. Clicking the name of the application pool takes you to the Application
Pool Details page.
n State: Displays the current state of the listed application pool. Possible states include: Stopped,
Started, Stopping, and Starting.
n Worker Processes: Displays the current number of worker processes the listed application pool is
using.
n CPU: Displays the percentage of CPU currently being used for the listed application pool.
n Physical Memory: Displays the amount of physical RAM the listed application pool is currently
using.
n Virtual Memory: Displays the amount of virtual RAM the listed application pool is currently using.
You can search for an application pool by entering text in the Search field and clicking Search.
865
Cache
This resource contains monitors specific to the current status of the IIS application cache. The icons of the
listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
866
File Cache Hits % Definition:
This performance counter returns the ratio of user-mode file
cache hits to the total number of cache requests since the
service started.
Information:
This counter reflects how well the settings for the IIS file cache
are working. A site with mostly static files should have a very
high cache hit percentage (70%-85%). If the Kernel: Cache
Hits % counter is low, this value should be high. Note that this
counter does not include dynamic content, only static files. If
your static files are not being cached, you might want to
lengthen the activity period for this cache.
Possible problems:
The value returned from Kernel: Cache Hits % is low.
Remediation:
If the value returned from Kernel: Cache Hits % is low,
examine your file set and determine why your files are not
being cached.
867
Information:
If content cannot be cached in the HTTP.sys response cache,
the value of this counter should be as high as possible. If your
content can be stored in the HTTP.sys response cache, the
value of this counter should be low.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
868
Connections
This resource contains monitors specific to the current status of the active connections for the current
IIS application. The icons of the listed performance counters in the Statistic Name column change colors to
reflect the listed counter's current state. Clicking any performance counter in the Statistic Name column
takes you to the Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Total Description:
Connection This displays the total number of connections to the Web or FTP service that have been
Attempts attempted since service startup. The count is the total for all web sites or FTP sites
combined, regardless of the instance selected.
Information:
This number does not include connection attempts that failed at the TCP (transport) or IP
(network) layer.
869
Information:
This number does not include failed logon attempts.
Current Description:
Connections This displays the current number of connections established with the Web service.
Information:
This is the sum of both non-anonymous (authenticated) and anonymous
(unauthenticated) users.
Possible problems:
If this number is at or near the maximum connections allowed, the Web service is near
or at full capacity.
Remediation:
If the value is too high for a particular IIS server, then load balancing or clustering
technologies can be applied to lower the burden of the server in question. Also check the
Web Site property page for maximum connection limit.
Current Description:
Anonymous This displays the number of Current Anonymous Users who currently have an
Users anonymous connection using the Web service.
Information:
If anonymous connections are not permitted on the server, the value of all anonymous
user counters is always zero.
Current Description:
Non- This displays the number of Current Non-Anonymous Users who currently have a non-
Anonymous anonymous connection using the Web service.
Users
Information:
If authentication is not enabled on the server, and none of the applications that run on
the server request or require authentication, then the value of all non-anonymous user
counters is always zero.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
870
IIS Average CPU and Memory Usage
This resource graphically and numerically details the consumption of IIS as it relates to the overall
resource utilization of the server itself. This allows you to determine if performance issues are caused by
IIS, or if IIS performance is impacted by other applications, processes, or services running on the server.
This resource has three tabs, allowing you to see the charts for CPU usage, Physical Memory Usage, and
Virtual Memory Usage. Hovering over any time period within the chart displays detailed information about
that time period in the tooltip. The colors of the main chart correspond to the labels in the legend. You can
choose which data to display by using the check boxes in the legend, as well as cycling through the three
different tabs.
The three columns to the right in the lower portion of the chart report the most recent percentage of CPU
Load, Physical Memory Usage, and Virtual Memory Usage, respectively, for each available worker process.
CPU and Memory need to be enabled via List Resources in order for this to function properly. If
CPU and Memory are not enabled, N/A is reported for other values when they are unselected.
871
n Application Pool (Worker Process): Lists the processes being monitored and displayed in the
chart. Non-IIS Processes and Services are those resources consumed by other applications running
on the server that are not associated with IIS.
n Latest CPU Load: Displays the percentage of CPU usage for the listed process.
n Latest Physical Memory Usage: Displays the percentage of physical memory in use for the listed
process.
n Latest Virtual Memory Usage: Displays the percentage of virtual memory in use for the listed
process.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific date range by dragging the mouse over an
area of the chart or manipulating the sliders of the lower chart.
872
IIS Average Network Traffic
This resource graphically details the history of IIS network traffic. Hovering over any time period within the
chart displays detailed information about that time period in the tooltip. The colors of the main chart
correspond to the labels in the legend. You can choose which data to display by using the check boxes in
the legend.
n Traffic Source: Lists the sources of network traffic that is displayed in the chart. Non-IIS Processes
and Services are those resources consumed by other applications running on the server that are not
associated with IIS.
n Latest Network Traffic: Displays the network traffic rate for the listed source in kilobytes per
second.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart or manipulating the sliders of the lower chart.
873
Event Log Message Details
This resource displays the IIS event log messages while providing a search window and a filter. The filter
allows you to choose which types of log messages you want to display. The data can be sorted by clicking
the headers of each column. This resource shows Error, Warning, Information events specific to the
monitored IIS server. For a complete list of Event IDs, see Event IDs
Clicking any event message in the list opens a new window, displaying the entire message. Click Edit to
alter the title, subtitle, and number or rows displayed.
874
Management
This resource contains controls that are actionable for both the application and the node. The controls in
the following illustration are SAM-specific.
Application:
n Edit Application Monitor: This allows you to edit the current application by changing the settings
specifically related to this application. This includes, but is not limited to: changing the polling
frequency, changing the Windows and PowerShell URLs, changing the IIS Server credentials, and
adjusting threshold settings for component monitors that have thresholds.
Note: Changing some settings may require you to override the template that this application is
based upon. To do this, click Override Template.
n Unmanage: Allows you to stop the polling and collecting of statistics of the current application for a
user-defined period of time.
n Poll Now: Allows the application to retrieve the most current statistics when clicked.
Note: By default, statistics are not polled when Poll Now is clicked.
Node:
n Real-Time Process Explorer: Opens the Real-Time Process Explorer in a new window. For more
information, see The Real Time Process Explorer.
n Service Control Manager: Opens the Service Control Manager in a new window. For more
information, see The Service Control Manager.
875
n Real-Time Event Viewer: Opens the Real-Time Event Viewer in a new window. For more
information, see The Real Time Event Log Viewer.
876
Processes and Services
This resource provides detailed information about the active processes and services associated with the
database selected. Hovering over a component gives you detailed information about that application.
877
Sites
This resource shows the status of all monitored sites of the current IIS application.
n Name: Displays the name of the listed site in addition to the current performance status as
indicated by the icon. Clicking the name of the site takes you to the Site Details page.
n State: Displays the current state of the listed site. Possible states include: Stopped, Started,
Stopping, and Starting.
n Connections: Displays the current number of connections for the listed sites.
n Response Time (Avg): Displays the average response time of the listed site in milliseconds.
n Start Mode: Displays how the listed site begins running. The ServerAutoStart property indicates if
the server instance should start automatically when the server is powered on. This property is reset
automatically when a server instance is stopped or restarted to maintain the state across service
restarts.
You can search for a site by entering text in the Search field and clicking Search.
878
Top Page Requests by Average Server Execution Time
This resource displays the top 20 page requests by average server execution time. The Average Server
Execution Time is the average time of all page requests of the same type based on the URL stem. (The
URL stem is part of a dynamic URL that separates the URL request from the query parameters. This is
typically located before the question mark.)
By clicking Edit, you can change the number of URLs this resource displays. The data can be sorted
by clicking the headers of each column.
Important: This resource is only shown when AppInsight for IIS is being polled via an Agent. It will
not appear if the node is being polled via SNMP or WMI. Additionally, when the IIS log format is
missing the required fields, this resource appears to be missing information. If this is the case,
either enable the following fields through the IIS manager, or disable this component entirely. The
fields that need to be enabled are: Date, Time, URI Query, Client IP Address, and Method in the
WCW3 format. For more information, see Agents. Logging must be enabled. The W3C or IIS log
format should be configured on the IIS server.
Notes:
n This resource is specific to the IIS site. Another instance of this resource is available at the
application level for all sites.
n IIS logging must be enabled. The W3C or IIS log format should be configured on the IIS server.
n Site: Displays the site name with which the URL is associated. Clicking the arrow to the left of the site
name brings up detailed information about the listed web request (URL), including the following:
879
n Verb: Displays the web request action performed. Example verbs shown in this column are
GET, POST, PUT, DELETE, HEAD, DELETE, OPTIONS, and CONNECT.
n Request Date: Displays the date and time of the client web request.
n Elapsed Time: Displays the amount of server time that was needed to fulfill the listed request.
n Client IP: Displays the IP address of the client computer for the listed request.
n URL Query: Displays the query parameters associated with client's web request. If no query
parameters were specified in the request, this field will be blank.
n URL: Displays the URL stem of the listed request.
n Average Server Execution Time: Displays the average time of all page requests of the same type
based on the URL stem.
880
ASP.NET
This resource contains monitors specific to the current status of the ASP.NET IIS application requests
which contain all the websites for the current application. The icons of the listed performance counters in
the Statistic Name column change colors to reflect the listed counter's current state. Clicking any
performance counter in the Statistic Name column takes you to the Performance Counter Details page for
that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
881
Information:
The execution time begins when the HttpContext for the
request is created, and stops before the response is sent to IIS.
Assuming that user code does not call HttpResponse.Flush, this
implies that execution time stops before sending any bytes to IIS, or
to the client. When the process model is enabled, the request
execution time includes the time required to write the response to
the client, and therefore depends upon the bandwidth of the
client's connection. There is no threshold for this counter. The
value of this counter should be stable. Experience helps you set a
threshold for a particular site.
Information:
This does not include any time spent waiting in application queues.
The threshold for this counter is 1,000. The average request should
spend 0 milliseconds waiting in the queue.
Possible problems:
If this indicator is greater than 1,000 ms, the performance of the IIS
server is suffering.
882
Information:
The Aspnet_wp process queue is a named pipe through which
the request is sent from one process to the other. The number of
requests in this queue increases if there is a shortage of available
I/O threads in the Aspnet_wp process. When the limit specified by
<processModel requestQueueLimit=/> is exceeded, requests
are rejected with a 503 error (Service Unavailable). Note that if a
request is rejected for this reason, it will never reach managed
code and error handlers will not be notified. Normally this only
occurs when the server is under a very heavy load. Virtual directory
queues maintain the availability of worker and I/O threads. The
number of requests in these queues increases if the number of
available worker threads or available I/O threads falls below the
limit specified by <httpRuntime minFreeThreads=/>. When
the limit specified by <httpRuntime
appRequestQueueLimit=/> is exceeded, the request is rejected
with a 503 error and the client is sent an HTTP exception with the
message, Service Unavailable.
Possible problems:
When this value starts to increment linearly with increased client
load, the web server computer has reached the limit of concurrent
requests that it can process.
Remediation:
The default maximum value for this counter is 5,000. You can
change this setting in the Machine.config file.
Information:
Requests are rejected when one of the queue limits is exceeded.
Back-end latency, such as that caused by a slow computer running
SQL Server, is often preceded by a sudden increase in the number
of pipeline instances and a decrease in % Processor Time and
Requests/second. A server might be overwhelmed during times of
heavy load due to processor or memory constraints that ultimately
result in the rejection of requests.
Possible problems:
The value of this counter should be 0. Values greater than 0 should
be investigated.
883
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
884
AppInsight for IIS Website Details View
The IIS Website Details view provides a great deal of information about the current IIS website. The
available resources offered in this view include:
n Bindings
n Connections
n Files
n Log Size by File
n Management
n Network I/O
n This resource contains monitors specific to the current status of the IIS site requests. The icons of
the listed performance counters in the Statistic Name column change colors to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you
to the Performance Counter Details page for that performance counter.
n Zooming
n Site Details
n Site Size by Directory
n SSL Certificate Expiration
n Top Page Requests by Average Server Execution Time
n Web Server Response Time
Chart resources may not display data until multiple successful polls have completed.
885
Bindings
886
Connections
This resource contains monitors specific to the current status of the active connections for the current
IIS website. The icons of the listed performance counters in the Statistic Name column change colors to
reflect the listed counter's current state. Clicking any performance counter in the Statistic Name column
takes you to the Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Total Description:
Connections This displays the total number of connections to the Web or FTP service that have been
Attempts attempted since service startup. The count is the total for all Web sites or FTP sites
combined, regardless of what you choose for the instance.
Information:
This number does not include connection attempts that failed at the TCP (transport) or IP
(network) layer.
887
Total Logon Description:
Attempts This displays the total number of successful logons to the Web or FTP service since the
service started.
Information:
This does not include failed logon attempts.
Current Description:
Connections This displays the current number of connections established with the Web service.
Information:
This is the sum of both nonanonymous (authenticated) and anonymous
(unauthenticated) users.
Possible problems:
If this number is at or near the maximum allowable connections, the Web service is at
full capacity.
Remediation:
If the value is too high for a particular IIS server, then load balancing or clustering
technologies can be applied to lower the burden of the server in question. Also, check
the Web Site property page for the maximum connection limit.
Current Description:
Anonymous This displays the number of users who currently have an anonymous connection using
Users the Web service.
Information:
If anonymous connections are not permitted on the server, the value of all anonymous
user counters is always zero.
Current Description:
Non- This displays the number of users who currently have a non-anonymous connection
Anonymous using the Web service.
Users
Information:
If authentication is not enabled on the server, and none of the applications that run on
the server request or require authentication, then the value of all nonanonymous user
counters is always zero.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
888
The Value from Last Poll column shows the most recent data available for the listed statistic.
889
Files
This resource contains monitors specific to file traffic across the current website. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Files Description:
Received The displays the number of files that have been received by the WWW
service since the service started.
Information:
This value does not include cache hits. Note that this counter does not
increment when files are being served from the kernel-mode cache.
890
Files Description:
Transferred The displays the sum of Files Sent and Files Received by the WWW service
since the service started.
Information:
Note that this counter does not increment when files are being served from
the kernel-mode cache.
Information:
This is usually reported as HTTP error 404.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
891
Log Size by File
This resource lists the current quantity and size of log files as sorted by size. If the Warning or Critical
thresholds is breached, the color of the bar chart changes from green to yellow or red, respectively.
n Folder Path: Displays the path to the directory where log files are stored. The path displayed is
linked to the Custom Chart page and can be accessed by clicking the displayed path.
n Number of Files: Displays the total number of log files in the listed directory.
n Total File Size: Displays, in bytes, the amount of disk space being used to store the total number of
log files in the listed directory.
n Volume Usage: Numerically and graphically displays the percentage of volume space used by the
listed log files.
892
Management
This resource contains controls that are actionable for the current site. The controls in the following
illustration are SAM-specific.
n Restart: This stops the site from running and then restarts it.
n Start/Stop: Allows you to start or stop the site.
n Unmanage Web Site: Allows you to stop the polling and collecting of statistics of the current web
site.
893
Network I/O
This resource contains monitors specific to byte traffic across the current website. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Information:
This information can be used to determine network load on a specific Web site.
Information:
This information can be used to determine network load on a specific Web site.
894
Information:
This information can be used to determine network load on a specific Web site.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
895
Requests
This resource contains monitors specific to the current status of the IIS site requests. The icons of the
listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Total Description:
Method This displays the number of HTTP requests that have been made since the WWW service
Requests started.
896
Delete Description:
Requests This displays the number of HTTP requests that have used the DELETE method since the
WWW service started.
Get Description:
Requests This displays the number of HTTP requests that have used the GET method since the WWW
service started.
Information:
GET requests are generally used for basic file retrievals or image maps, though they can be
used with forms.
Head Description:
Requests This displays the number of HTTP requests that have used the HEAD method since the
WWW service started.
Information:
HEAD requests typically indicate that a client is querying the state of a document they
already have to see if it needs to be refreshed.
CGI Description:
Requests This displays the number of all CGI requests that have been made since the WWW service
started.
Information:
CGI requests are custom gateway executable (.exe) files the administrator can install to add
forms processing or other dynamic data sources. CGI requests spawn a process on the
server which can be a large drain on server resources.
ISAPI Description:
Extension This displays the number extension of ISAPI requests that have been made since the WWW
Requests service started.
Information:
ISAPI Extension Requests are custom gateway DLLs which the administrator can install to
add forms processing or other dynamic data sources.
Put Description:
Requests This displays the number of HTTP requests using the PUT method since the WWW service
started.
Post Description:
Requests This displays the number of HTTP requests that have used the POST method since the
WWW service started.
Information:
Post requests are generally used for forms or gateway requests.
897
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
898
Site Availability
This resource graphically shows the various states of a website's availability in a percentage format and is
made up of three sections: the legend, the main chart, and the lower chart. The colors of the main chart
correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific time range by dragging the mouse over a
small area of the chart.
Once you have a time period selected, the lower chart will zoom to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart will display the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart will reveal a tooltip with more detailed information about the
specific time period the mouse is hovering over. By default, all statistics are shown in the main chart.
899
Site Details
900
Site Size by Directory
This resource lists and details site size by directory for the current site.
n Folder Path: Displays the folder path for the current site.
n Number of Files: Displays the total number of files located in the folder path for the current site.
n Total File Size: Displays the total size, in MB, for all of the files located in the folder path for the
current site.
n Volume Usage: Numerically and graphically displays the total percentage of volume space
consumed by the current site.
901
SSL Certificate Expiration
This resource provides graphical and numerical information pertaining to the valid dates of your SSL
certificates as well as the number of days remaining before the listed certificates expire.
n CN (Common Name): An SSL certificate is required to be associated with one or more hostnames,
called Common Name. In this resource, CN is followed by the hostname with which it is associated.
n Days Remaining: The number of days remaining until the listed certificate expires is
represented both graphically and numerically.
n Valid Between: Displays the date range when the listed certificate is valid.
n Port: Displays the port to which the listed certificate is bound.
902
Top Page Requests by Average Server Execution Time
This resource displays the top 20 page requests by average server execution time. The Average Server
Execution Time is the average time of all page requests of the same type based on the URL stem.
The URL stem is part of a dynamic URL that separates the URL request from the query parameters.
This is typically located before the question mark.
By clicking Edit, you can change the number of URLs this resource displays. The data can be sorted by
clicking the headers of each column.
Important: This resource is only shown when AppInsight for IIS is being polled via an Agent. It will
not appear if the node is being polled via SNMP or WMI. Additionally, when the IIS log format is
missing the required fields, this resource appears to be missing information. If this is the case,
either enable the following fields through the IIS manager, or disable this component entirely. The
fields that need to be enabled are: Date, Time, URI Query, Client IP Address, and Method in the
WCW3 format. For more information, see SolarWinds Orion Agents . Logging must be enabled. The
W3C or IIS log format should be configured on the IIS server.
Notes:
n This resource is specific to the IIS site. Another instance of this resource is available at the
application level for all sites.
n IIS logging must be enabled. The W3C or IIS log format should be configured on the IIS server.
n Site: Displays the site name with which the URL is associated. Clicking the arrow to the left of the site
name brings up detailed information about the listed web request (URL), including the following:
903
n Verb: Displays the web request action performed. Example verbs shown in this column are
GET, POST, PUT, DELETE, HEAD, DELETE, OPTIONS, and CONNECT.
n Request Date: Displays the date and time of the client web request.
n Elapsed Time: Displays the amount of server time that was needed to fulfill the listed request.
n Client IP: Displays the IP address of the client computer for the listed request.
n URL Query: Displays the query parameters associated with client's web request. If no query
parameters were specified in the request, this field will be blank.
n URL: Displays the URL stem of the listed request.
n Average Server Execution Time: Displays the average time of all page requests of the same type
based on the URL stem.
904
Web Server Response Time
This resource contains monitors specific to the response time of the current web server. The icons of the
listed performance counters in the Statistic Name column will change color to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column will take you to the
Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
will display a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter will display a red background. Hovering over any time period within the chart will
display detailed information about that time period in the tooltip. Hovering over a counter will give you
detailed information about that performance counter.
HTTP Monitor Definition:
This performance counter returns the amount of time the listed web server
spends accepting incoming sessions and transmitting the requested page, in
milliseconds, for the HTTP protocol.
HTTPS Monitor Definition:
This performance counter returns the amount of time the listed web server
spends accepting incoming sessions and transmitting the requested page, in
milliseconds, for the HTTPS protocol.
The HTTPS monitor will not appear if the site is not configured for HTTPS. Similarly, if the Orion
server is unable access an HTTP site via its configured URL, this resource will not appear because
these components will automatically be disabled. You can re-enable and configure these monitors
via the application editor.
Zooming
905
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
906
AppInsight for IIS Application Pool Details View
The IIS Application Pools Details view provides a great deal of information about the current IIS application
pool. The available resources offered in this view include:
Chart resources may not display data until multiple successful polls have completed.
907
Application Pool Availability
This resource graphically shows the various states of an application pool's availability in a percentage
format and is made up of three sections: the legend, the main chart, and the lower chart. The colors of the
main chart correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons; 1 hour, 12 hours, or 24 hours. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
The Export button opens the Custom Chart allowing you to export this data to both MS Excel and HTML.
908
Application Pool Details
n Application Pool Name: Displays the name of the listed application pool.
n Application Pool State: Displays the current state of the listed application pool. Possible states
include Started, Stopped, and Unknown.
n Worker Process Status: Displays the current status of the listed worker processes. Possible
statuses include Up, Down, Not Running, Warning, Critical, and Unknown.
n Start Automatically: Displays how the listed application pool is started. Possible values include Yes
and No.
n Start Mode: Displays the current configuration mode. The Application Pool can be set to run in On
Demand Mode or Always Running Mode.
n .Net Framework Version: Displays the version of Microsoft's .Net framework currently utilized by
the application pool.
n Manage Pipeline Mode: Displays how ASP.Net is configured. Classic Mode is an ISAPI extension.
Integrated Mode is where managed code is integrated into the request processing pipeline. Possible
values include Classic Mode and Integrated Mode.
n Identity: Displays the configuration of the Application Pool as either a Built-in Account, Network
Service, Local System, Local Service, or as a Specific User Identity.
n Applications: Displays the number of applications that rely upon this Application Pool.
909
Management
This resource contains controls that are actionable for the application pool. The controls in the following
illustration are SAM-specific.
n Recycle: Allows the worker process that handles requests for that application pool to be terminated
and a new one started.
n Start/Stop: Allows you to start and stop the worker processes of the application pool.
n Unmanage Application Pool: Allows you to stop the polling and collecting of statistics of the
current application pool.
910
Worker Process Activation Service
This resource contains monitors specific to the worker process activation service for the current
application pool. The icons of the listed performance counters in the Statistic Name column will change
color to reflect the listed counter's current state. Clicking any performance counter in the Statistic Name
column will take you to the Performance Counter Details page for that performance counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
911
Recent Worker Description: > 0 (CaD
Process Failures This displays the number of times that the worker process for the enabled)
application pool failed during the rapid-fail protection interval.
Information:
This counter should be counted as difference with a threshold greater
than 0.
Information:
This counter should be counted as difference with a threshold greater
than 0.
Information:
This counter should be counted as difference with a threshold greater
than 0.
Information:
This counter should be counted as difference with a threshold greater
than 0.
Information:
This counter should be counted as difference with a threshold greater
912
than 0.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
913
Worker Process Cache
This resource contains monitors specific to worker process cache for the current application pool. The
icons of the listed performance counters in the Statistic Name column will change color to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column will take you to the
Performance Counter Details page for that performance counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
914
Counter Expert Knowledge
Current Description:
File Cache This displays the current number of bytes used by the user-mode file cache.
Memory
Information:
Usage
The value of this counter and the value of Web Service Cache and Maximum File Cache
Memory Usage should be the same.
Possible problems:
If the values are different, this means the cache was flushed.
Remediation:
If this counter is significantly lower than Web Service Cache and Maximum File Cache
Memory Usage, consider recycling the worker process because the application might have
a memory leak.
Maximum Description:
File Cache This displays the maximum number of bytes used by the user-mode file cache since
Memory service startup.
Usage
Information:
The value of this counter and the value of Web Service Cache and Current File Cache
Memory Usage should be the same.
Possible problems:
If the values are different, this means the cache was flushed.
Remediation:
If this counter is significantly higher than Web Service Cache and Current File Cache
Memory Usage, consider recycling the worker process because the application might have
a memory leak.
Output Description:
Cache This displays the current number of bytes used by the output cache.
Current
Memory
Usage
File Description:
Cache This displays the total number of successful lookups in the user-mode file cache since
Hits service startup.
Information:
Understanding this output depends on the content. For example, if the content files cannot
be cached by HTTP.sys, a high value is good
915
File Description:
Cache This displays the total number of unsuccessful lookups in the user-mode file cache since
Misses service startup.
Information:
A file cache miss means the request for the file must go to the hard disk.
Possible problems:
File cache misses negatively impact performance and scalability. This value should be as
low as possible. Also note that kernel cache hits will cause this value to be low.
Metadata Description:
Cache This displays the total number of successful lookups in the user-mode metadata cache
Hits since service startup.
Metadata Description:
Cache This displays the total number of unsuccessful lookups in the user-mode metadata cache
Misses since service startup.
Information:
This value should be as low as possible.
Output Description:
Cache This displays the total number of successful lookups in the output cache since service
Total Hits startup.
Output Description:
Cache This displays the total number of unsuccessful lookups in the output cache since service
Total startup.
Misses
URI Description:
Cache This displays the total number of successful lookups in the user-mode URI cache since
Hits service startup.
Information:
Understanding this output depends on the content. For example, if the content cannot be
cached in the HTTP.sys response cache, the value of this counter should be as high as
possible. If your content can be stored in the HTTP.sys response cache, the value of this
counter should be low.
URI Description:
Cache This displays the total number of unsuccessful lookups in the user-mode URI cache since
Misses service startup.
916
Information: A low value is preferable. The value of this counter increases when IIS
cannot locate the requested content in either the HTTP.sys response cache or the IIS file
cache, and must locate the requested content on the hard disk.
Possible problems:
If the value of this counter is high, IIS locates the requested content on the hard disk which
could slow overall performance.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
917
Worker Process Details
This resource provides details concerning the listed worker process. Clicking >> View Details will take you
to Worker Process Statistic Monitor Details page for additional information.
918
Worker Process Requests and Threads
This resource contains monitors specific to worker process requests and threads for the current
application pool. The icons of the listed performance counters in the Statistic Name column will change
color to reflect the listed counter's current state. Clicking any performance counter in the Statistic Name
column will take you to the Performance Counter Details page for that performance counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
Requests/sec Description:
HTTP requests/sec being processed by the worker process.
Zooming
919
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
920
AppInsight for Exchange
AppInsight for Exchange was designed exclusively for the mailbox role which offers a detailed view of your
Exchange environment. This application provides detailed metrics on mailboxes, databases, and a host of
performance counters without the use of agents or templates. Use Applnsight for Exchange to monitor
virtually every aspect of your Exchange environment.
After it is applied to a node, AppInsight for Exchange is considered an application. AppInsight for Exchange
is comprised of multiple component monitors.
To optimize your Exchange server performance, see 5 Tips to Optimize Exchange Server for
Improved Performance.
921
Find Exchange credentials
The verify you have valid Exchange credentials, run the following cmdlet in the Exchange Management
Shell (EMS):
922
Attachment extensions acknowledged by AppInsight for Exchange
The following table lists the default attachment extensions that are acknowledged by AppInsight for
Exchange:
923
Understand the AppInsight for Exchange Details view
n Active Alerts
n Application Availability
n Application Details
n Calendar and Resource Booking
n Critical Processes and Services
n Exchange Event Log Message Details
n Exchange Server
n Information Store
n Mailbox Database Copies
n Mailbox Database Size and Space Use
n Mailbox Database Status
n Mail Database
n Management
n Replication
n Replication Status Checks
n Storage
n Users By Mailbox Size
n Users By Percent Mailbox Quota Used
n Users By Messages Sent
924
Active Alerts
n Time of Alert: Displays the time and date the listed alert was triggered.
n Object Name: Displays the object that triggered the alert. Clicking the object takes you to the details
page for that object.
n Message: Displays the message of the listed alert.
925
Application Availability
This resource graphically shows the various states of an application in a percentage format and is made
up of three sections: the legend, the main chart, and the lower chart. The colors of the main chart
correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons; 1 hour, 12 hours, or 24 hours. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
926
The Export button opens the Custom Chart allowing you to export this data to both MS Excel and
HTML.
927
Application Details
n Application Name: This provides the name of the current application as well as the name of the
node on which it is active. Hovering over the node name reveals a detailed tooltip concerning the
health of that node.
n Status: Displays the current status of the application.
n Exchange Server Version: Displays the current version of Exchange that is being monitored.
n Exchange Server Build Number: This is Microsoft's internal versioning number system that
indicates the version of Exchange installed. For more information, refer to this article:
http://technet.microsoft.com/library/hh135098%28EXCHG.141%29.aspx
n Exchange Domain: The domain of the listed Exchange server.
928
n Database Availability Group (DAG): This contains information pertaining to the DAG of which the
local node belongs.
n DAG Name: Name of the listed Database Availability Group.
n Other Exchange Servers in DAG: Lists additional Exchange servers in the current DAG.
n File Share Witness: The File Share Witness (FSW) is the quorum directory for the DAG Cluster.
It is used to provide a majority node set in a DAG with an even number of members. In a DAG
with an odd number of members, the FSW still exists, but is not used to determine a majority
node set. For additional information, see:
http://blogs.technet.com/b/askpfeplat/archive/2012/06/27/clustering-what-exactly-is-a-file-
share-witness-and-when-should-i-use-one.aspx
n Witness Share in use: This is the current witness share in use.
Note: This field may be replaced with the Alternate File Share Witness field.
n (Alternate File Share Witness): The Alternate FSW is used when the primary site with the
FSW has failed. To use the Alternate FSW requires manual intervention from the Exchange
administrator.
Note: This field may be replaced with the Witness Share in use field.
929
Calendar and Resource Booking
This resource contains performance counters specific to the status of calendar and resource booking. The
icons of the listed performance counters in the Statistic Name column change colors to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you to the
Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
Calendaring is the method of creating, changing, deleting, accepting, or declining a meeting via an email
message. Resource booking is an automated process of creating, changing, and deleting calendar requests
for resource mailboxes. The Calendar and Resource Booking Attendant are the processes used by
Exchange to fulfill requests for each. Once a request has been accepted, the free/busy data for the
mailbox is updated.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
930
Possible problems:
High values may indicate a performance bottleneck.
Remediation:
Check Memory and CPU status for any bottlenecks.Review event logs for
related events examining log entries for each Assistants Infrastructure
and its corresponding assistant. Use the Exchange Troubleshooting
Assistant (ExTRA) to obtain Event Tracing for Windows traces.
Possible problems:
Meeting Room bookings or updates may not be processed for some
users.
Remediation:
Review event logs for related events examining log entries for each
Assistants Infrastructure and its corresponding assistant. Use the
Exchange Troubleshooting Assistant (ExTRA) to obtain Event Tracing for
Windows traces. Verify your resource mailboxes are properly configured.
Remediation:
Check Memory and CPU for any bottlenecks. Review event logs for
related events examining log entries for each Assistants Infrastructure
and its corresponding assistant. Use the Exchange Troubleshooting
Assistant (ExTRA) to obtain Event Tracing for Windows traces.
931
Possible problems:
Automated calendaring activities may not function for some users.
Remediation:
Review event logs for related events examining log entries for each
Assistants Infrastructure and its corresponding assistant. Use the
Exchange Troubleshooting Assistant (ExTRA) to obtain Event Tracing for
Windows traces. Verify your resource mailboxes are properly configured.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page
932
Critical Processes and Services
This resource numerically and graphically shows metrics concerning the Exchange's critical processes and
services. The icons of the listed component in the Component Name column change color to reflect the
listed counter's current state. Clicking any component in the Component Name column takes you to the
Component Details page for that component.
If the value of the listed component crosses the Warning threshold, the icon for the listed component
becomes yellow. If the value of the listed component crosses the Critical threshold, the icon for the listed
component becomes red.
933
Display Name Description
Microsoft Provides Active Directory topology information to Exchange services. If this service is
Exchange stopped, most Exchange services are unable to start. This service has no dependencies.
Active
Directory
Topology
Microsoft Manages the Exchange Information Store. This includes mailbox databases and public folder
Exchange databases. If this service is stopped, mailbox databases and public folder databases on this
computer are unavailable. If this service is disabled, any services that explicitly depend on it fail to
Information
start. This service is dependent on the RPC, Server, Windows Event Log, and Workstation
Store
services.
Microsoft Submits messages from the Mailbox server to Exchange 2010 Hub Transport servers. This
Exchange Mail service is dependent upon the Microsoft Exchange Active Directory Topology service.
Submission
Microsoft Performs background processing of mailboxes in the Exchange store. This service is
Exchange dependent upon the Microsoft Exchange Active Directory Topology service.
Mailbox
Assistant
Microsoft Allows applications to call the Exchange diagnostic cmdlets. This service has no dependencies.
Exchange
Monitoring
Microsoft Provides replication functionality for mailbox databases on Mailbox servers in a database
Exchange availability group (DAG) and database mount functionality for all Mailbox servers. This service is
dependent upon the Microsoft Exchange Active Directory Topology service.
Replication
Microsoft Manages client RPC connections for Exchange. This service is dependent upon the
Exchange RPC Microsoft Exchange Active Directory Topology service.
Client Access
Microsoft Drives indexing of mailbox content, which improves the performance of content search. This
Exchange service is dependent upon the Microsoft Exchange Active Directory Topology and Microsoft
Search Indexer Search (Exchange Server) services.
Microsoft Enables Windows Server Backup users to back up and recover application data for Microsoft
Exchange Exchange. This service has no dependencies.
Server
Extension for
Windows
Server Backup
Microsoft Provides a host for several Microsoft Exchange services. On internal server roles, this service is
Exchange dependent upon the Microsoft Exchange Active Directory Topology service.
Service Host
934
Microsoft Forwards directory lookups to a global catalog server for legacy Outlook clients, generates e-mail
Exchange addresses and OABs, updates free/busy information for legacy clients, and maintains
permissions and group memberships for the server. If this service is disabled, any services that
System
explicitly depend on it fail to start. This service is dependent on the RPC, Server, Windows Event
Attendant
Log, and Workstation services.
Microsoft Limits the rate of user operations. This service is dependent upon the Microsoft Exchange Active
Exchange Directory Topology service.
Throttling
Microsoft Provides remote search capability for Microsoft Exchange Transport log files. This service
Exchange is dependent upon the Microsoft Exchange Active Directory Topology service.
Transport Log
Search
Microsoft This is a Microsoft Exchange-customized version of Microsoft Search. Quickly creates full-text
Search indexes on content and properties of structured and semi-structured data to allow fast linguistic
(Exchange) searches on this data. This service is dependent on the RPC service.
Display Name Description
Microsoft Provides Active Directory topology information to Exchange services. If this service is
Exchange stopped, most Exchange services are unable to start. This service is dependent on the
Active Net.Tcp Port Sharing Service.
Directory
Topology
Microsoft The Microsoft Forefront Protection 2010 for Exchange Server anti-spam update service. This
Exchange Anti- service is dependent upon the Microsoft Exchange Active Directory Topology service.
spam Update
Microsoft This service, running on the Mailbox servers, receives mail items from the Exchange Transport
Exchange service, submits them to extension modules for processing and commits them into mailbox
database. This service is dependent upon the Microsoft Exchange Active Directory Topology
Mailbox
service.
Transport
Delivery
Microsoft Replicates configuration and recipient data from the Hub Transport servers to the Edge
Exchange Transport servers. This service is dependent upon the Microsoft Exchange Active Directory
Topology service.
EdgeSync
935
Exchange Drives indexing and querying of data for Exchange. This service is dependent upon the
Search Microsoft Exchange Active Directory Topology service.
Microsoft Manages Exchange server health. This service is dependent on the Windows Event Log
Exchange service.
Health
Manager
Microsoft Provides Internet Message Access Protocol service to mailboxes. If this service is stopped,
Exchange mailboxes on this server cannot be accessed using the IMAP4 protocol. This service is
dependent upon the Microsoft Exchange Active Directory Topology service.
IMAP4
Backend
Microsoft This process controls all of the Store Worker processes. If a DB is dismounted, it is responsible
Exchange for terminating the associated Store Worker process and if a DB is mounted, it starts a new
Store Worker process. If this service is disabled, any services that explicitly depend on it fail to
Information
start. This service is dependent on the Microsoft Exchange Active Directory Topology, RPC,
Store
Server, Windows Event Log, and Workstation services.
N/A Each database hosted on a server creates a separate process for each one. This
process performs the same work as the 'store.exe process did in previous versions, just
on an individual DB basis. This process is dependent on the Microsoft Exchange
Information Store service.
Microsoft Performs background processing of mailboxes in the Exchange store. This service is
Exchange dependent upon the Microsoft Exchange Active Directory Topology service.
Mailbox
Assistant
Microsoft Processes mailbox move requests. This service is dependent on the Microsoft
Exchange Exchange Active Directory Topology and Net.Tcp Port Sharing services. This service is
dependent upon the Microsoft Exchange Active Directory Topology service.
Mailbox
Replication
Microsoft Allows applications to call the Exchange diagnostic cmdlets. This service has no
Exchange dependencies.
Monitoring
Microsoft Provides Post Office Protocol version 3 service to mailboxes. If this service is stopped,
Exchange mailboxes on this server cannot be accessed using the POP3 protocol.
POP3 Backend
Microsoft Provides replication functionality for mailbox databases on Mailbox servers in a database
Exchange availability group (DAG) and database mount functionality for all Mailbox servers. This service
is dependent upon the Microsoft Exchange Active Directory Topology service.
Replication
936
Microsoft Manages client RPC connections for Exchange. This service is dependent upon the
Exchange RPC Microsoft Exchange Active Directory Topology service.
Client Access
Microsoft Enables Windows Server Backup users to back up and recover application data for Microsoft
Exchange Exchange. This service has no dependencies.
Server
Extension for
Windows
Server Backup
Microsoft This service provides host level deployment and management services for applications.
Exchange This service is dependent upon the HTTP service.
Search Host
Controller
Microsoft Provides a host for several Exchange services. On internal server roles, this service is
Exchange dependent upon the Microsoft Exchange Active Directory Topology service.
Service Host
Microsoft This service, running on the Mailbox servers, receives the Submit events, processes the
Exchange messages by converting them from MAPI to MIME and hands them over to the Exchange
Transport service. This service is dependent upon the Microsoft Exchange Active Directory
Mailbox
Topology service.
Transport
Submission
Microsoft Limits the rate of user operations. This service is dependent upon the Microsoft
Exchange Exchange Active Directory Topology service.
Throttling
Microsoft Acts as a middle man and routes messages between Mailbox Transport Submission service
Exchange and the Front End Transport service. It is identical to the Hub Transport Server role in
Transport Exchange 2010. Never contacts the mailbox databases directly. This service is dependent
upon the Microsoft Exchange Active Directory Topology and Microsoft Filtering Management
services.
Microsoft Provides remote search capability for Microsoft Exchange Transport log files. This
Exchange service is dependent upon the Microsoft Exchange Active Directory Topology service.
Transport Log
Search
Microsoft Enables Microsoft Exchange Unified Messaging features. This allows voice and fax messages
Exchange to be stored in Microsoft Exchange and gives users telephone access to e-mail, voice mail,
calendar, contacts, or an auto attendant. If this service is stopped, Unified Messaging is not
Unified
available. This service is dependent upon the Microsoft Exchange Active Directory Topology
Messaging
service.
937
Exchange Event Log Message Details
This resource displays the Exchange event log messages while providing a search window and a filter. The
filter allows you to choose which types of log messages you want to display. The data can be sorted by
clicking the headers of each column. This resource shows Error, Warning, Information, Security Audit
Success, and Security Audit Failure events specific to the monitored Exchange server.
Clicking any event message in the list will open a new window, displaying the entire message.
938
Exchange Server
This resource contains performance counters specific to the current status of the Exchange Server. The
icons of the listed performance counters in the Statistic Name column will change color to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column will take you to
the Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
939
RPC Definition: >1 > 1 for
Requests Shows the percentage of failed requests in the total number of RPC 15
failed (%) requests. Failed means the sum of failed with error code plus failed polls
with exception.
Information:
Should be less than 1 at all times
Possible problems:
Users may report slow performance, disconnects, or failures within their
client performing certain activities.
Remediation:
Review the Windows Event logs for any related events. Use ExBPA to
perform a Health scan of your server and review any issues reported. In
Exchange 2010, verify SP1 or higher has been installed on your system.
Possible problems:
Server may stop accepting RPC requests.
Remediation:
Review the Windows Event logs for any related events. Use ExBPA to
perform a Health scan of your server and review any issues reported.
Use Exchange Server User Monitor application to review user
sessions. In Exchange 2010, verify SP1 or higher has been installed on
your system.
Possible problems:
Users may report slow performance issues.
Remediation:
If the disk subsystem is not meeting demand, correcting the problem
may require additional disks, faster disks, or modifying the disk
configuration.
940
RPC Definition: N/A N/A
Requests RPC Requests sent/sec is the current rate of initiated RPC requests per
sent/sec second.
Information:
Used for determining current load.
Remediation:
Review the Windows Event logs for any related events. Use ExBPA to
perform a Health scan of your server and review any issues reported. In
Exchange 2010, verify SP1 or higher has been installed on your system.
Information:
A slow RPC request is one that has taken more than 500 ms.Should be
less than 1 at all times.
Possible problems:
Client disconnects or slow performance issues.
Remediation:
Review the Windows Event logs for any related events. Use ExBPA to
perform a Health scan of your server and review any issues reported. In
Exchange 2010, verify SP 1 or higher has been installed on your system.
Information:
Used for determining current load.
Information:
Should be 0 at all times.
941
(Only Possible problems:
available in Domain where you send large amount of email is unavailable, infected
Exchange machine on network sending messages, DNS resolution issues, or
2010) network connectivity to destination servers or the internet.
Remediation:
Determine the root cause and verify there aren't any network
connectivity issues.
Remediation:
For any database indexes not "healthy," update the content Index on the
server using the following command: Update-MailboxDatabaseCopy
<DBName> -CatalogOnly
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page
942
Information Store
This resource contains performance counters specific to the status of the current Information Store. The
icons of the listed performance counters in the Statistic Name column changes color to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you to the
Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
The Exchange Information Store is a storage platform that is used to manage numerous types of
information within an Exchange server deployment.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
943
Connection Definition: N/A N/A
Count Is the total number of client connections maintained.
(Only Information:
available in This is used to determine current load of the server's Information Store.
Exchange
Possible problems:
2013)
May cause memory bottlenecks on the server if the number is
excessively high.
Remediation:
Reduce the number of user mailboxes hosted on the server or increase
available resources.
Information:
Used to determine current user load on the server. Each active user
typically starts up to 5 active sessions (connections) on a server, in order
to sync various services.
Possible problems:
May cause memory bottlenecks on the server if the number is
excessively high.
Remediation:
Determine if users are running applications not required for business
use, and request they do not run these applications which is causing an
increase in server logons. If this does not help, or is not possible, reduce
the number of users hosted on the server and move any Public Folders
on the server to a different server.
Possible problems:
To determine if certain protocols are causing overall RPC latencies,
monitor MSExchangeIS Client (*)\RPC Average Latency to separate
latencies based on client protocol.
944
Remediation:
Faster disks, more disks, or redesigning existing disk arrays.
Information:
Should be below 70 at all times.
Possible problems:
When I/O counters fall outside of normal range, client performance is
directly impacted. For example, Outlook and Outlook Web App (OWA)
users report “Outlook is slow” when opening mail or moving between
folders.
Remediation:
Faster disks, more disks, or redesigning existing disk arrays.
(Only Information:
available in This is used to determine current load of the server's Information Store.
Exchange
Possible problems:
2010)
May cause memory bottlenecks on the server if the number is
excessively high.
Remediation:
Reduce the number of user mailboxes hosted on the server or increase
available resources.
945
Remediation:
Check if RPC latencies are high and determine the cause of the
performance issue (e.g. poorly performing disk I/O, excessive load,
insufficient memory, high number of users).
(Only Information:
available in Indicates the rate at which client backoffs are occurring.
Exchange
Possible problems:
2010)
Higher values may indicate that the server may be incurring a higher
load resulting in an increase in overall averaged RPC latencies, causing
client throttling to occur. This can also occur when certain client user
actions are being performed. Depending on what the client is doing and
the rate at which RPC operations are occurring, it may be normal to see
backoffs occurring.
Remediation:
Check if RPC latencies are high and determine the cause of the
performance issue (e.g. poorly performing disk I/O, excessive load,
insufficient memory, high number of users).
(Only Information:
available in Active client logons can be high if users are logging on and logging off
Exchange frequently.
2010)
Possible problems:
May cause memory bottlenecks on the server if the number is
excessively high.
Remediation:
Determine if users are running applications not required for business
use, and request they do not run these applications which is causing an
increase in server logons. If this does not help, or is not possible, reduce
the number of server hosted on the server and move any Public Folders
on the server to a different server.
946
(Only Information:
available in The queues should remain below 50 at any given time. Anything above
Exchange this amount should be cleared within 15 minutes.
2010)
Possible problems:
Mailbox server is not communicating properly with the transport server.
Remediation:
Verify network connectivity and transport server functionality.
(Only Information:
available in Should be no more than 10 for any specific mailbox store.
Exchange
Possible problems:
2010)
Higher values indicate applications are crawling or searching mailboxes,
which is affecting server performance. These include desktop search
engines, customer relationship management (CRM), or other third-party
applications.
Remediation:
Run the ResetSearchIndex.ps1 script which is located in the scripts
directory at the root of the Exchange installation. Alternatively, you can
perform the process manually:
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page
947
Mailbox Database Copies
This resource shows the status of the Exchange mailbox database copies. The data can be sorted by
clicking the headers of each column.
Hovering over any Database Name in the list displays detailed information about that database in the
tooltip. Hovering over the node provides a tooltip with information about that node.
Table 1.
Mounted The active copy is online and accepting client connections. Only the active copy of the
mailbox database copy can have a copy status of Mounted.
Mounting The active copy is coming online and not yet accepting client connections. Only the active
copy of the mailbox database copy can have a copy status of Mounting.
Dismounting The active copy is going offline and terminating client connections. Only the active copy of
the mailbox database copy can have a copy status of Dismounting.
Dismounted The active copy is offline and not accepting client connections. Only the active copy of the
mailbox database copy can have a copy status of Dismounted.
948
Seeding The mailbox database copy is being seeded, the content index for the mailbox database
copy is being seeded, or both are being seeded. Upon successful completion of seeding,
the copy status should change to Initializing.
Seeding The mailbox database copy is being used as a source for a database copy seeding
Source operation.
Initializing The mailbox database copy is in an Initializing state when a database copy has been
created, when the Microsoft Exchange Replication service is starting or has just been
started, and during transitions from Suspended, Service Down, Failed, Seeding, or Single
Page Restore to another state. While in this state, the system is verifying that the database
and log stream are in a consistent state. In most cases, the copy status remains in the
Initializing state for about 15 seconds, but in all cases, it should generally not be in this
state for longer than 30 seconds.
Re- The mailbox database copy and its log files are being compared with the active copy of the
synchronizing database to check for any divergence between the two copies. The copy status remains in
this state until any divergence is detected and resolved.
Single Page This state indicates that a single page restore operation is occurring on the mailbox
Restore database copy.
Failed The mailbox database copy is in a Failed state because it is not suspended, and it is not
able to copy or replay log files. While in a Failed state and not suspended, the system
periodically checks whether the problem that caused the copy status to change to Failed
has been resolved. After the system has detected that the problem is resolved, and
barring no other issues, the copy status automatically changes to Healthy.
Service Down The Microsoft Exchange Replication service is not available or running on the server that
hosts the mailbox database copy.
Healthy The mailbox database copy is successfully copying and replaying log files, or it has
successfully copied and replayed all available log files.
Disconnected The mailbox database copy is no longer connected to the active database copy, and it was
and Healthy in the Healthy state when the loss of connection occurred. This state represents the
database copy with respect to connectivity to its source database copy. It may be reported
during DAG network failures between the source copy and the target database copy.
949
Disconnected The mailbox database copy is no longer connected to the active database copy, and it was
and Re- in the Re-synchronizing state when the loss of connection occurred. This state represents
synchronizing the database copy with respect to connectivity to its source database copy. It may be
reported during DAG network failures between the source copy and the target database
copy.
Failed and The Failed and Suspended states have been set simultaneously by the system because a
Suspended failure was detected, and because resolution of the failure explicitly requires
administrator intervention. An example is if the system detects unrecoverable divergence
between the active mailbox database and a database copy. Unlike the Failed state, the
system will not periodically check whether the problem has been resolved, and
automatically recover. Instead, an administrator must intervene to resolve the underlying
cause of the failure before the database copy can be transitioned to a healthy state.
Table 2.
Crawling Database is in the process of indexing database content. Depending on the size Warning
of the database, this process could take some time to complete.
Failed An error has occurred causing the content index to fail. Critical
Failed and The Failed and Suspended states have been set simultaneously by the system Critical
Suspended because a failure was detected, and because resolution of the failure explicitly
requires administrator intervention.
Healthy This indicates the Content Index is up to date and has not detected any issues. Up
This is the only state in which a failover (automatic process) to a specific
database copy can occur.
Seeding A database copy is in the process of updating its Content Index from another Up
database copy.
Suspended The Suspended status occurs if an administrator manually pauses or suspends Warning
it from receiving updates from the active copy. This might be done to update a
failed Content Index or to perform troubleshooting for other issues.
950
Mailbox Database Size and Space Use
This resource numerically and graphically shows metrics concerning the Exchange mailbox database size.
The data can be sorted by clicking the headers of each column.
Hovering over any Database Name in the list displays detailed information about that database in the
tooltip. Clicking any database in the Database column takes you to the Database Details page for that
database.
951
Mailbox Database Status
This resource provides details concerning the status of the current mailbox database being monitored by
the application.
Mounted The active copy is online and accepting client connections. Only the active copy of
the mailbox database copy can have a copy status of Mounted.
Mounting The active copy is coming online and not yet accepting client connections. Only the
active copy of the mailbox database copy can have a copy status of Mounting.
Dismounting The active copy is going offline and terminating client connections. Only the active
copy of the mailbox database copy can have a copy status of Dismounting.
Dismounted The active copy is offline and not accepting client connections. Only the active copy
of the mailbox database copy can have a copy status of Dismounted.
Seeding The mailbox database copy is being seeded, the content index for the mailbox
database copy is being seeded, or both are being seeded. Upon successful
completion of seeding, the copy status should change to Initializing.
Seeding The mailbox database copy is being used as a source for a database copy seeding
Source operation.
Initializing The mailbox database copy is in an Initializing state when a database copy has been
created, when the Microsoft Exchange Replication service is starting or has just
been started, and during transitions from Suspended, ServiceDown, Failed,
Seeding, or SinglePageRestore to another state. While in this state, the system is
verifying that the database and log stream are in a consistent state. In most cases,
the copy status remains in the Initializing state for about 15 seconds, but in all
cases, it should generally not be in this state for longer than 30 seconds.
Re- The mailbox database copy and its log files are being compared with the active copy
synchronizing of the database to check for any divergence between the two copies. The copy status
remains in this state until any divergence is detected and resolved.
952
Single Page This state indicates that a single page restore operation is occurring on the mailbox
Restore database copy.
Failed The mailbox database copy is in a Failed state because it isnot suspended, and it
isnot able to copy or replay log files. While in a Failed state and not suspended, the
system periodically checks whether the problem that caused the copy status to
change to Failed has been resolved. After the system has detected that the problem
is resolved, and barring no other issues, the copy status will automatically change to
Healthy.
Service Down The Microsoft Exchange Replication service isnot available or running on the server
that hosts the mailbox database copy.
Suspended The mailbox database copy is in a Suspended state as a result of an administrator
manually suspending the database copy by running the Suspend-
MailboxDatabaseCopy cmdlet.
Healthy The mailbox database copy is successfully copying and replaying log files, or it has
successfully copied and replayed all available log files.
Disconnected The mailbox database copy is no longer connected to the active database copy, and
and Healthy it was in the Healthy state when the loss of connection occurred. This state
represents the database copy with respect to connectivity to its source database
copy. It may be reported during DAG network failures between the source copy and
the target database copy.
Disconnected The mailbox database copy is no longer connected to the active database copy, and
and Re- it was in the Re-synchronizing state when the loss of connection occurred. This state
synchronizing represents the database copy with respect to connectivity to its source database
copy. It may be reported during DAG network failures between the source copy and
the target database copy.
Failed and The Failed and Suspended states have been set simultaneously by the system
Suspended because a failure was detected, and because resolution of the failure explicitly
requires administrator intervention. An example is if the system detects
unrecoverable divergence between the active mailbox database and a database
copy. Unlike the Failed state, the system will not periodically check whether the
problem has been resolved, and automatically recover. Instead, an administrator
must intervene to resolve the underlying cause of the failure before the database
copy can be transitioned to a healthy state.
n Copy Queue Length: The copy queue length is an integer indicating number of files. The Copy
Queue Length shows the number of transaction log files waiting to be copied to the passive copy log
file folder. A copy is not considered complete until it has been checked for corruption.
n Replay Queue Length: The Replay Queue Length shows the number of transaction log files waiting
to be replayed into the passive copy.
n Last Inspected Log Time: This is the date and time when the last log file was verified (inspected) by
the LogInspector for a particular database after being copied from the active copy. This field is only
relevant for passive copies of a database.
n Content Index State: See the following table for returned status descriptions.
953
State Description Status on
Active &
Passive
Copies
Crawling Database is in the process of indexing database content. Depending on the Warning
size of the database, this process could take some time to complete.
Disabled Indexing for the database has been disable by an administrator. Offline
(Active)
N/A
(Passive)
Failed An error has occurred causing the content index to fail. Critical
Failed and The Failed and Suspended states have been set simultaneously by the Critical
Suspended system because a failure was detected, and because resolution of the
failure explicitly requires administrator intervention.
Healthy This indicates the Content Index is up to date and has not detected any Up
issues. This is the only state in which a failover (automatic process) to a
specific database copy can occur.
Seeding A database copy is in the process of updating its Content Index from Up
another database copy.
Suspended The Suspended status occurs if an administrator manually pauses or Warning
suspends it from receiving updates from the active copy. This might be
done to update a failed Content Index or to perform troubleshooting for
other issues.
n Activation Preference: Indicates which database copy has preference over another copy. It is used
as part of the formula to determine which database copy will become active during a failover. The
value can range from 1 to 16 depending on the number of servers in the DAG. The lower the
number, the higher the preference.
954
Mail Database
This resource contains performance counters specific to the status of the current Mail Database. The icons
of the listed performance counters in the Statistic Name column change colors to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you to the
Performance Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
Information:
This and Database Cache Hit % are useful counters for gauging whether a
server's performance problems might be resolved by adding more physical
memory. Use this counter along with store private bytes to determine if
there are store memory leaks.
955
Possible problems:
Situation when the database cache size seems too small for optimal
performance and there is little available memory on the system (check the
value of Memory/Available Bytes) could negatively impact on performance.
If there is ample memory on the system and the database cache size is not
growing beyond a certain point, the database cache size may be capped at
an artificially low limit. Increasing this limit may increase performance.
Remediation:
Adding more memory to the system and/or increasing database cache size
may increase performance.
Possible problems:
If this value is nonzero, this indicates that the database is not able to flush
dirty pages to the database file fast enough to make pages free for new
page allocations.
Remediation:
If the disk subsystem is not meeting demand, correcting the problem may
require additional disks, faster disks, or modifying the disk configuration.
Possible problems:
Typically indicates a database transaction which is taking a long time to
save to disk. During Online DB defrags, the version buckets may increase.
Remediation:
Verify if the server has any applications running that have a long running
transaction which has not been saved to disk, causing the version store
memory resource to be exhausted.
956
Log Definition: > 10 for > 10 for
Record Shows the number of log records that can't be added to the log buffers per 15 polls 60
Stalls/sec second because the log buffers are full. If this counter is nonzero for a long polls
period of time, the log buffer size may be a bottleneck.
Information:
The average value should be below 10 per second. Spikes (maximum
values) should not be higher than 100 per second.
Possible problems:
If I/O log write latencies are high, check for RAID5 or synchronize
replication on log devices.
Remediation:
You can also use the MSExchange Database Instances (Information
store/<Database Name>)\log record stalls/sec counter to determine which
database(s) may be having issues. This assists you in determining which
drive(s) to focus on. This counter is an extended Exchange counter in
Performance Monitor. The solution can include additional disks,
reconfigured RAID configuration, adding new database(s), or re-balancing
mailboxes across databases or servers.
Information:
Should be less than 10 on average.
Possible problems:
If this number is too high, the log may be a bottleneck. Regular spikes
concurrent with log record stall spikes indicate that the transaction log
disks are a bottleneck. If the value for log threads waiting is more than the
spindles available for the logs, there is a bottleneck on the log disks.
Remediation:
If the disk subsystem is not meeting demand, correcting the problem may
require additional disks, faster disks, or modifying the disk configuration.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
957
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page.
958
Management
This resource contains controls that are actionable for both the application and the node. The controls in
the following illustration are SAM-specific.
Application:
n Edit Application Monitor: This allows you to edit the current application by changing the settings
specifically related to this application. This includes, but is not limited to: changing the polling
frequency, changing the Windows and PowerShell URLs, changing the Exchange Server credentials,
and adjusting threshold settings for component monitors that have thresholds. Changing some
settings may require you to override the template that this application is based upon. To do this,
simply click Override Template.
n Unmanage: Allows you to stop the polling and collecting of statistics of the current application for a
user-defined period of time.
n Poll Now: Allows the application to retrieve the most current statistics when clicked.
Note: By default, mailbox statistics are not polled when Poll Now is clicked.
Node:
n Real-Time Process Explorer: Opens the RTPE in a new window. For more information, see The Real
Time Process Explorer.
n Service Control Manager: Opens the SCM in a new window. For more information, see The Service
Control Manager.
n Real-Time Event Viewer: Opens the RTEV in a new window. For more information, see The Real
Time Event Log Viewer.
959
Replication
This resource contains performance counters specific to the status of the current replication process. The
icons of the listed performance counters in the Statistic Name column changes color to reflect the listed
counter's current state. Clicking any performance counter in the Statistic Name column takes you to the
Performance Counter Details page for that counter.
If the value of a listed performance counter approaches or crosses the Warning threshold, a yellow band
will appear for the listed counter allowing plotted values that cross the threshold to easily be visualized
against the yellow band. If the value of a listed performance counter approaches or crosses the Critical
threshold, a red band will appear for the listed counter allowing plotted values that cross the threshold to
easily be visualized against the red band. Hovering over any time period within the chart will display
detailed information about that time period in the tooltip. Hovering over a counter will give you detailed
information about that performance counter.
The purpose of using data replication is to maintain current replicas of the data. Exchange servers can use
the replicas to provide continuity of email service in the event of a storage or site outage in the primary
location.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
960
CopyQueueLength Definition: >1 > 1 for
Shows the number of transaction log files waiting to be copied 5 polls
to the passive copy log file folder. A copy isn't considered
complete until it has been checked for corruption.
Information:
All nodes in a Database Availability Group (DAG) should be
monitored for this counter depending on the passive node.
Should be less than 1 at all times for continuous replication.
Possible problems:
Server recently rebooted or services restarted, network
connectivity issues, or multiple mailbox moves are in process.
Remediation:
Verify network connectivity between the various nodes in the
DAG. Verify Replication Service is running on all DAG members.
Information:
With DAG replication, transaction logs are shipped to the other
DAG members. They then replay the log file. (Thresholds
should be manually removed for DAG members configured to
be 'lagged copies.')
Possible problems:
The replay queue length should be as low as possible,
otherwise this could indicate a (performance) issue with the
DAG member containing the Copy database. A high number
could also negatively affect failover with some loss of data as a
possibility.
Remediation:
Check Memory, CPU, and Disk I/O for any bottlenecks. Review
the Windows Event logs for any related events.
961
Information:
Shows the size in KB/sec of the transaction logs being copied
to passive copies.
Information:
Shows you the number of Transaction Logs being replayed on
the passive copies of a database.
Information:
Exchange 2010/2013 uses continuous replication to create and
maintain database copies. To maintain a synchronized copy of
a mailbox database, transaction log files from the active
mailbox server are replayed into the passive database of
another server in the DAG. This provides high availability and
resiliency in the Exchange environment.
Possible problems:
Indicates a replication issue may exist with the mailbox
database copies in the DAG. If Transaction Log replay is not
able to keep up with the active copy, passive copies will not be
up of date.
Remediation:
Review the Windows Event logs for any related events. Examine
network topology between DAG members and verify
connectivity and network latency is below 250 ms. Examine
CPU utilization by the Information Store service on passive
copies. Examine the replication status for each replica
database using the Get-MailboxDatabaseCopyStatus
cmdlet.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
962
Additional components on certain resources may be available for addition or deletion on the Edit
page.
963
Replication Status Checks
This resource performs up to 16 checks in Exchange 2010 and up to 18 checks in Exchange 2013 (divided
into two columns. This resource only shows test results which apply to the server it is being run against,
whether the server contains only active databases, passive databases, or a combination of the two. The
fewest checks are performed when run against a server with only active databases (Seven checks for 2010,
12 checks for 2013). This is because check for databases replication status is not necessary because they
are all on the local server.
The status for each Health Check Test can be one of the following: Passed, Failed, or Warning.
The table below provides a list of all possible tests for this resource along with their definitions.
TcpListener Verifies that the TCP log copy listener is running and reachable on the
specified DAG member, or if no DAG member is specified, on the local
server.
TasksRpcListener Verifies that the tasks remote procedure call (RPC) server is running and
reachable on the specified DAG member, or if no DAG member is
specified, on the local server.
ReplayService Verifies that the Microsoft Exchange Replication service is running and
reachable on the specified DAG member, or if no DAG member is
specified, on the local server.
QuorumGroup Verifies that the default cluster group (quorum group) is in a healthy
and online state.
964
FileShareQuorum Verifies that the witness server and witness directory and share
configured for the DAG are reachable.
DBLogReplayKeepingUp Verifies that replay activity for the passive copies of databases on the
specified DAG member, or if no DAG member is specified, on the local
server, is able to keep up with log copying and inspection activity.
DBLogCopyKeepingUp Verifies that log copying and inspection by the passive copies of
databases on the specified DAG member, or if no DAG member is
specified, on the local server, are able to keep up with log generation
activity on the active copy.
DBCopyFailed Checks whether any mailbox database copies are in a state of Failed on
the specified DAG member, or if no DAG member is specified, on the
local server.
DatabaseRedundancy (Only Verifies that there is at least one healthy copy available of the databases
2013) on the specified DAG member, or if no DAG member is specified, on the
local server.
DatabaseAvailability (Only 2013) Verifies that the databases have sufficient availability on the specified
DAG member, or if no DAG member is specified, on the local server.
DagMembersUp Verifies that all DAG members are available, running, and reachable.
ClusterService Verifies that the Cluster service is running and reachable on the
specified DAG member, or if no DAG member is specified, on the local
server.
ActiveManager Verifies that the instance of Active Manager running on the specified
DAG member, or if no DAG member is specified, the local server, is in a
valid role (primary, secondary, or stand-alone).
965
Storage
This resource contains performance counters specific to the status of storage. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
Information:
Should be 20 ms on average. Spikes should not exceed 50 ms.
Possible problems:
Users may report sluggish responsiveness within their email
client.
966
Remediation:
If the disk subsystem is not meeting demand, correcting the
problem may require additional disks, faster disks, or modifying
the disk configuration.
Information:
Should be 50 ms on average. Spikes of up to 100 ms are
acceptable if not accompanied by database page fault stalls.
Possible problems:
Users may report sluggish responsiveness within their email
client.
Remediation:
If the disk subsystem is not meeting demand, correcting the
problem may require additional disks, faster disks, or modifying
the disk configuration.
Possible problems:
Users may report sluggish responsiveness within their email
client.
Remediation:
If the disk subsystem is not meeting demand, correcting the
problem may require additional disks, faster disks, or modifying
the disk configuration.
Information:
This count should be 10 ms or less on production servers.
Possible problems:
Indication that the MS Exchange Database\I/O Database Writes
Average Latency is too high
967
Remediation:
If the disk subsystem is not meeting demand, correcting the
problem may require additional disks, faster disks, or modifying
the disk configuration.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page.
968
Users By Mailbox Size
This resource numerically and graphically shows metrics concerning mailbox size per user. The data can
be sorted by clicking the headers of each column.
Hovering over any user in the User Name list will display detailed information about that user's mailbox in
the tooltip. Clicking any database in the Database column will take you to the Database Details page for
that database.
Notes
n If there are no user mailboxes on a given database, this resources will disappear from the Mailbox
Database Details page.
n If there are no user mailboxes in any of the active databases on an Exchange server, this resource
will disappear from the Application Details page.
n User mailbox information is collected only once a day after midnight, local time.
For more information, see Attachment extensions acknowledged by AppInsight for Exchange.
969
Users By Percent Mailbox Quota Used
This resource shows metrics based on the percentage of a user's mailbox quota used. The data can be
sorted by clicking the headers of each column.
Hovering over any user in the User Name list will display detailed information about that user's mailbox in
the tooltip. Clicking any database in the Database column will take you to the Database Details page for
that database.
If there are no user mailboxes or mailbox quotas are not in use on a given database, this resources
will disappear from the Mailbox Database Details page. If there are no user mailboxes or mailbox
quotas are not in use in any of the active databases on an Exchange server, this resource will
disappear from the Application Details page. User mailbox information is collected only once a day
after midnight, local time.
For more information, see Attachment extensions acknowledged by AppInsight for Exchange.
970
Users By Messages Sent
This resource shows metrics based on messages sent. The data can be sorted by clicking the headers of
each column.
Hovering over any user in the User Name list will display detailed information about that user's mailbox in
the tooltip. Clicking any database in the Database column will take you to the Database Details page for
that database.
If there are no user mailboxes on a given database, this resources will disappear from the Mailbox
Database Details page. If there are no user mailboxes in any of the active databases on an Exchange
server, this resource will disappear from the Application Details page. User mailbox information is
collected only once a day after midnight, local time. If Server Mailbox Accounts Statistics is disabled,
this resource, as well as the Messages Sent and Messages Received charts on the Mailbox Details
view, will disappear.
971
AppInsight for Exchange Database Details View
You may need to log in with an administrator account to perform this action.
1. On the web console, navigate to the AppInsight for Exchange Details view by clicking and AppInsight
for Exchange application in the All Applications resource.
2. From a Database resource, click any database in the list.
If the name of a database is extremely long, certain performance counters may not be visible on the
Database Details page. If databases are grouped by a status of Unknown in Network Atlas,
AppInsight for Exchange databases will be displayed.
972
Active Mounted Database Availability
This resource graphically shows the various states of database availability in a percentage format and is
made up of three sections: the legend, the main chart, and the lower chart. The colors of the main chart
correspond to the labels in the legend.
This resource is not available when using Internet Explorer 7. Consider upgrading Internet Explorer
8 or higher or using FireFox or Chrome as your web browser.
Zooming
You can have the chart show a predetermined, hourly time period of data by clicking on any one of the
three Zoom buttons; 1h, 12h, or 24h. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over. By default, all statistics are shown in the main chart.
973
Database Copies
This resource provides details concerning the status of the current Exchange server being monitored by
the application.
Mounted The active copy is online and accepting client connections. Only the active copy of
the mailbox database copy can have a copy status of Mounted.
Mounting The active copy is coming online and not yet accepting client connections. Only the
active copy of the mailbox database copy can have a copy status of Mounting.
Dismounting The active copy is going offline and terminating client connections. Only the active
copy of the mailbox database copy can have a copy status of Dismounting.
Dismounted The active copy is offline and not accepting client connections. Only the active copy
of the mailbox database copy can have a copy status of Dismounted.
Seeding The mailbox database copy is being seeded, the content index for the mailbox
database copy is being seeded, or both are being seeded. Upon successful
completion of seeding, the copy status should change to Initializing.
Seeding The mailbox database copy is being used as a source for a database copy seeding
Source operation.
Initializing The mailbox database copy is in an Initializing state when a database copy has been
created, when the Microsoft Exchange Replication service is starting or has just
been started, and during transitions from Suspended, ServiceDown, Failed,
Seeding, or SinglePageRestore to another state. While in this state, the system is
verifying that the database and log stream are in a consistent state. In most cases,
the copy status remains in the Initializing state for about 15 seconds, but in all
cases, it should generally not be in this state for longer than 30 seconds.
Re- The mailbox database copy and its log files are being compared with the active copy
synchronizing of the database to check for any divergence between the two copies. The copy status
remains in this state until any divergence is detected and resolved.
Single Page This state indicates that a single page restore operation is occurring on the mailbox
Restore database copy.
974
Failed The mailbox database copy is in a Failed state because it isnot suspended, and it
isnot able to copy or replay log files. While in a Failed state and not suspended, the
system periodically checks whether the problem that caused the copy status to
change to Failed has been resolved. After the system has detected that the problem
is resolved, and barring no other issues, the copy status automatically changes to
Healthy.
Service Down The Microsoft Exchange Replication service isnot available or running on the server
that hosts the mailbox database copy.
Suspended The mailbox database copy is in a Suspended state as a result of an administrator
manually suspending the database copy by running the Suspend-
MailboxDatabaseCopy cmdlet.
Healthy The mailbox database copy is successfully copying and replaying log files, or it has
successfully copied and replayed all available log files.
Disconnected The mailbox database copy is no longer connected to the active database copy, and
and Healthy it was in the Healthy state when the loss of connection occurred. This state
represents the database copy with respect to connectivity to its source database
copy. It may be reported during DAG network failures between the source copy and
the target database copy.
Disconnected The mailbox database copy is no longer connected to the active database copy, and
and Re- it was in the Re-synchronizing state when the loss of connection occurred. This state
synchronizing represents the database copy with respect to connectivity to its source database
copy. It may be reported during DAG network failures between the source copy and
the target database copy.
Failed and The Failed and Suspended states have been set simultaneously by the system
Suspended because a failure was detected, and because resolution of the failure explicitly
requires administrator intervention. An example is if the system detects
unrecoverable divergence between the active mailbox database and a database
copy. Unlike the Failed state, the system will not periodically check whether the
problem has been resolved, and automatically recover. Instead, an administrator
must intervene to resolve the underlying cause of the failure before the database
copy can be transitioned to a healthy state.
n Copy Queue: The Copy Queue length is an integer indicating number of files. The Copy Queue
Length shows the number of transaction log files waiting to be copied to the passive copy log file
folder. A copy is not considered complete until it has been checked for corruption.
n Replay Queue: The Replay Queue Length shows the number of transaction log files waiting to be
replayed into the passive copy.
n Inspected Log Time: This is the date and time when the last log file was verified (inspected) by the
LogInspector for a particular database after being copied from the active copy. This field is only
relevant for passive copies of a database.
n Content Index: See the following table for returned status descriptions.
975
Crawling Database is in the process of indexing database content. Depending on the Warning
size of the database, this process could take some time to complete.
Disabled Indexing for the database has been disable by an administrator. Offline
(Active)
N/A
(Passive)
Failed An error has occurred causing the content index to fail. Critical
Failed and The Failed and Suspended states have been set simultaneously by the Critical
Suspended system because a failure was detected, and because resolution of the
failure explicitly requires administrator intervention.
Healthy This indicates the Content Index is up to date and has not detected any Up
issues. This is the only state in which a failover (automatic process) to a
specific database copy can occur.
Seeding A database copy is in the process of updating its Content Index from Up
another database copy.
Suspended The Suspended status occurs if an administrator manually pauses or Warning
suspends it from receiving updates from the active copy. This might be
done to update a failed Content Index or to perform troubleshooting for
other issues.
n Activation Preference: Indicates which database copy has preference over another copy. It is used
as part of the formula to determine which database copy will become active during a failover. The
value can range from 1 to 16 depending on the number of servers in the DAG. The lower the
number, the higher the preference.
976
Database Details
977
n Last Incremented Backup: Displays the time and date of only those files that have been altered
since the last full backup of the database.
n Circular Logging: Circular logging is a method of conserving disk space by deleting transaction log
files after they have been committed to the database. Circular Logging should only be enabled if the
mailbox server is part of a DAG with a minimum of three database copies and one of those should be
set as a "lagged copy."
n Storage Quota Defaults:
n Issue Warning: Displays the minimum size the mailbox must be before a Warning is issued to
the user's mailbox.
n Prohibit Send: Displays the minimum size the mailbox must be before sending email is
prohibited from the user's mailbox.
n Prohibit Send and Receive: Displays the minimum size the mailbox must be before sending
and receiving email is prohibited from the user's mailbox.
Table 1.
This table shows how the value for the Summary Status field is calculated. If the conditions in the first four
columns are met, the status in the Final SAM Status column is displayed in the Summary Status field.
978
Mounted, Seeding, or FailedAndSuspended Healthy, Seeding, Any Warning
SeedingSource or SeedingSource
979
Mounted, Seeding, or Service Down Healthy, Seeding, Any Warning
SeedingSource or SeedingSource
980
SinglePageRestore Seeding Any other Any Critical
Table 2.
Mounted The active copy is online and accepting client connections. Only the active copy of the
mailbox database copy can have a copy status of Mounted.
Mounting The active copy is coming online and not yet accepting client connections. Only the active
copy of the mailbox database copy can have a copy status of Mounting.
Dismounting The active copy is going offline and terminating client connections. Only the active copy of
the mailbox database copy can have a copy status of Dismounting.
Dismounted The active copy is offline and not accepting client connections. Only the active copy of the
mailbox database copy can have a copy status of Dismounted.
Seeding The mailbox database copy is being seeded, the content index for the mailbox database
copy is being seeded, or both are being seeded. Upon successful completion of seeding,
the copy status should change to Initializing.
Seeding The mailbox database copy is being used as a source for a database copy seeding
Source operation.
Initializing The mailbox database copy is in an Initializing state when a database copy has been
created, when the Microsoft Exchange Replication service is starting or has just been
started, and during transitions from Suspended, Service Down, Failed, Seeding, or Single
Page Restore to another state. While in this state, the system is verifying that the database
and log stream are in a consistent state. In most cases, the copy status remains in the
Initializing state for about 15 seconds, but in all cases, it should generally not be in this
state for longer than 30 seconds.
Re- The mailbox database copy and its log files are being compared with the active copy of the
synchronizing database to check for any divergence between the two copies. The copy status remains in
this state until any divergence is detected and resolved.
981
Single Page This state indicates that a single page restore operation is occurring on the mailbox
Restore database copy.
Failed The mailbox database copy is in a Failed state because it is not suspended, and it is not
able to copy or replay log files. While in a Failed state and not suspended, the system
periodically checks whether the problem that caused the copy status to change to Failed
has been resolved. After the system has detected that the problem is resolved, and
barring no other issues, the copy status automatically changes to Healthy.
Service Down The Microsoft Exchange Replication service is not available or running on the server that
hosts the mailbox database copy.
Healthy The mailbox database copy is successfully copying and replaying log files, or it has
successfully copied and replayed all available log files.
Disconnected The mailbox database copy is no longer connected to the active database copy, and it was
and Healthy in the Healthy state when the loss of connection occurred. This state represents the
database copy with respect to connectivity to its source database copy. It may be reported
during DAG network failures between the source copy and the target database copy.
Disconnected The mailbox database copy is no longer connected to the active database copy, and it was
and Re- in the Re-synchronizing state when the loss of connection occurred. This state represents
synchronizing the database copy with respect to connectivity to its source database copy. It may be
reported during DAG network failures between the source copy and the target database
copy.
Failed and The Failed and Suspended states have been set simultaneously by the system because a
Suspended failure was detected, and because resolution of the failure explicitly requires
administrator intervention. An example is if the system detects unrecoverable divergence
between the active mailbox database and a database copy. Unlike the Failed state, the
system does not periodically check whether the problem has been resolved, and
automatically recover. Instead, an administrator must intervene to resolve the underlying
cause of the failure before the database copy can be transitioned to a healthy state.
982
Database Disk Input Output
This resource provides details concerning the database disk I/O being monitored by the application.
983
Database File Size
This resource provides details concerning the size of the listed database copies being monitored by the
application.
984
Database Input and Output
This resource contains performance counters specific to the status of database I/O. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
985
Remediation:
If the disk subsystem is not meeting demand, correcting the problem may
require additional disks, faster disks, or modifying the disk configuration.
Review the event logs for related events. Verify network topology between
mailbox servers and storage resources. Examine CPU & Memory usage to
determine possible bottlenecks. Examine replication status for replica
database.
Possible problems:
Users may experience decreased performance, including delayed message
deliveries.
Remediation:
If the disk subsystem is not meeting demand, correcting the problem may
require additional disks, faster disks, or modifying the disk
configuration. Review the event logs for related events. Verify network
topology between mailbox servers & storage resources. Examine CPU and
Memory usage to determine possible bottlenecks. Examine replication
status for replica database.
Possible problems:
Users may experience decreased performance, including delayed message
deliveries.
986
I/O Log Definition: > 10 ms > 10
Writes Indicates the average time, in ms, to write a log buffer to the active log file. ms for
Average 5 polls
Information:
Latency
This count should be 10 ms or less on production servers.
Possible problems:
Indication that the Exchange Database\I/O Database Writes Average Latency
is too high
Information:
Should be less than 10 on average.
Possible problems:
If this number is too high, the log may be a bottleneck. Regular spikes
concurrent with log record stall spikes indicate that the transaction log
disks are in a bottleneck situation. If the value for log threads waiting is
more than the spindles available for the logs, there is a bottleneck on the
log disks.
Remediation:
If the disk subsystem is not meeting demand, correcting the problem may
require additional disks, faster disks, or modifying the disk
configuration. Review the event logs for related events. Verify network
topology between mailbox servers and storage resources. Examine CPU and
Memory usage to determine possible bottlenecks.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
987
Additional components on certain resources may be available for addition or deletion on the Edit
page.
988
Database Metrics
This resource contains performance counters specific to the status of database metrics. The icons of the
listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
Possible problems:
May cause memory bottlenecks on the server if the number
is excessively high.
989
Remediation:
Determine if users are running applications not required
for business use and request they do not run these
applications which is causing an increase in server logons.
If this does not help, or is not possible, reduce the number
of server hosted on the server and move any public folders
on the server to a different server.
Possible problems:
Higher values indicate applications are crawling or
searching mailboxes, which is affecting server performance.
These include desktop search engines, customer
relationship management (CRM), or other third-party
applications.
Remediation:
Run the ResetSearchIndex.ps1 script which is located
in the scripts directory at the root of the Exchange
installation. Alternatively, you can perform the process
manually:
Average Document Definition: Shows the average, in ms, of how long it takes to > 30 > 30 for
Indexing Time index documents. 15
polls
(At the database level, Information: Should be less than 30 seconds at all times.
this is only available in
Possible problems: Verify content index state of all
Exchange 2010. At the
database copies.
application level, this is
available for both Remediation: For any database indexes not "healthy,"
Exchange 2010 and update the content index on the server using the Update-
2013.) MailboxDatabaseCopy <DBName> -CatalogOnly
command.
990
Mailboxes Definition: Shows the rate of mailboxes processed by time- N/A N/A
processed/sec based assistants per second.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page.
991
Events
This resource contains performance counters specific to the status of database events. The icons of the
listed performance counters in the Statistic Name column change colors to reflect the listed counter's
current state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
Remediation:
Review event logs for related events examining log entries for each
Assistant's infrastructure and its corresponding assistant.
992
Information:
Should be a low value at all times.
Possible problems:
High values may indicate a performance bottleneck.
Remediation:
Review event logs for related events. Monitor CPU and memory for
bottlenecks.
Information:
Determines current load statistics for this counter.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page.
993
Messages
This resource contains performance counters specific to the status of messages. The icons of the listed
performance counters in the Statistic Name column change colors to reflect the listed counter's current
state. Clicking any performance counter in the Statistic Name column takes you to the Performance
Counter Details page for that performance counter.
If the value of a listed performance counter crosses the Warning threshold, the chart for the listed counter
displays a yellow background. If the value of a listed monitor crosses the Critical threshold, the chart for
the listed counter displays a red background. Hovering over any time period within the chart displays
detailed information about that time period in the tooltip. Hovering over a counter gives you detailed
information about that performance counter.
The following table lists the default performance counters for this resource along with their respective
definitions and troubleshooting information, including default Warning and Critical thresholds:
Possible problems:
Mailbox server is not communicating properly with the transport
server.
Remediation:
Verify network connectivity and transport server functionality.
Additional bottlenecks may include disk reads or writes, processor
time, available memory, and network configuration.
994
Messages Definition: N/A N/A
Sent/sec Shows the rate that messages are sent to transport.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
The Value from Last Poll column shows the most recent data available for the listed statistic.
Additional components on certain resources may be available for addition or deletion on the Edit
page.
995
Transaction Log Disk Input and Output
This resource provides details concerning the status of the current transaction log disk I/O of database
copies being monitored by the application.
996
Transaction Log File Size
This resource provides details concerning the status of the current transaction log file size of database
copies being monitored by the application.
997
Understand the AppInsight for Exchange Mailbox Details view
The Mailbox Details view provides information about the selected Exchange mailbox. The available
resources offered in this view include:
n Mailbox Details
n Mailbox Synced Devices
n Received Mail
n Sent Mail
n Total Mailbox and Attachments Sizes
998
Mailbox Details
999
n Mailbox Limits:
n Issue Warning: Displays the size limit of the mailbox before it issues a usage warning.
n Prohibit Send: Displays the size limit of the mailbox when it is no longer able to send emails.
n Prohibit Send and Receive: Displays the size limit of the mailbox when it is no longer able to
send or receive emails.
For more information, see Attachment extensions acknowledged by AppInsight for Exchange.
1000
Mailbox Synced Devices
This resource provides details about the current user's synced mailbox status.
n Device Type: Lists the device the mailbox is being synced with.
n Device User Agent: Displays the operating system and build of the listed device.
n Last Successful Sync: Displays the last time the listed device was successfully synced with the
current mailbox.
1001
Received Mail
This resource graphically details the value history of the current performance counter, in this case, the
total amount of received mail for the selected mailbox. Hovering over any time period within the chart
displays detailed information about that time period in the tooltip.
The colors of the main chart correspond to the labels in the legend. You can choose which data to display
by using the check boxes in the legend.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart or manipulating the sliders of the lower chart.
1002
Sent Mail
This resource graphically details the value history of the current performance counter, in this case, the
number of messages sent for the selected mailbox. Hovering over any time period within the chart
displays detailed information about that time period in the tooltip.
The colors of the main chart correspond to the labels in the legend. You can choose which data to display
by using the check boxes in the legend.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart or manipulating the sliders of the lower chart.
1003
Total Mailbox and Attachments Sizes
This resource graphically details the value history of the current performance counter, in this case, the
total size of the selected mailbox and its attachments. Hovering over any time period within the chart
displays detailed information about that time period in the tooltip.
The colors of the main chart correspond to the labels in the legend. You can choose which data to display
by using the check boxes in the legend.
Attachment Size shows the total size of those email messages that include attachments, including
the email message body.
For more information, see Mailbox Details.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart or manipulating the sliders of the lower chart.
1004
The AppInsight Performance Counter Details view
This view is equivalent to the Component Details view in a typical SAM application. This view is common to
all AppInsight applications and can be accessed by clicking any performance counter found in any
resource.
Additionally, this view contains the Management resource and Expert Knowledge resource.
1005
Average Site Response Time
This resource graphically details the average value history of the current performance counter, in this
case, the average response time of for the HTTP Bindings monitor. Hovering over any time period within
the chart displays detailed information about that time period in the tooltip.
The colors of the main chart correspond to the labels in the legend. You can choose which data to display
by using the check boxes in the legend.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific time range by dragging the mouse over a
small area of the chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over. By default, all statistics are shown in the main chart.
1006
Performance Counters
This resource displays all the available performance counters associated with the current application or
database.
The list of performance counters displayed changes depending on how you enter this view. For example, if
you enter this view by drilling down from the database level, just the counters associated with that
database are displayed. If you enter this view by drilling down from the application view, then only the
performance counters associated with the application are shown.
Clicking any performance counter in the list displays detailed information about that performance counter
in the Performance Counter Details resource.
1007
Performance Counter Details
This resource provides tools and detailed information about the current performance counter (Component
Monitor).
1008
History Chart
This resource graphically details the value history of the current performance counter. Hovering over any
time period within the chart displays detailed information about that time period in the tooltip.
The colors of the main chart correspond to the labels in the legend. You can choose which data to display
by using the check boxes in the legend.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons. Alternatively, you can have the chart show a specific time range by dragging the mouse over a
small area of the chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
Moving the mouse over the main chart reveals a tooltip with more detailed information about the specific
time period the mouse is hovering over. By default, all statistics are shown in the main chart.
1009
The AppStack environment
The Application Stack, or AppStack, is a term used to describe the various layers that make up a complex
application delivery infrastructure. The AppStack Environment view is an interactive visual mapping within
Orion that provides an in-depth perspective through the entire environment to help identify the root cause
of performance and availability issues.
AppStack automatically gathers information about objects in your environment, as well as their respective
relationships, and display them. Some relationships, such as groups and dependencies can be defined by
the user.
Important: As a standalone product, AppStack is available in the software versions listed below. If
you own two or more of the listed products, AppStack does not function properly unless each
version of the software is upgraded to the versions listed.
1010
Introduction to the AppStack Environment view
The AppStack Environment view is designed to provide you with a powerful layer of troubleshooting
visibility by exposing all participating objects in your environment, as well as their relationships to one
another. This view is useful in assessing the overall health of your environment, as well as troubleshooting
specific and related problems.
To help you better understand how this visualization of your environment can be used for troubleshooting,
the following analogy was designed to provide you with a simple, high-level overview of how AppStack
processes and displays information.
Imagine you work for a company comprised of many employees that work in various departments. In this
example, you work in the Engineering department as an engineer:
Now imagine you call in sick and are unable to work for two weeks. Certain employees in various
departments are affected by your absence. Others are not be affected. The illustration below highlights
the employees who are affected by your absence by fading those who are not affected.
1011
Focusing on only the people who are affected by your absence can be beneficial from a task management
perspective. Therefore, completely hiding those not affected by your absence gives a clean and concise
view, displaying only the necessary information.
Now, instead of employees, imagine we are talking about your entire IT environment. The goal of the
AppStack Environment view is to help you quickly assess the impact a given object has on its related
objects. This relational view is the AppStack Environment view found in the web console.
1012
The AppStack Environment View
The AppStack Environment, shown below, displays the status of individual objects in your IT environment
through the Orion web console. Objects are categorized and ordered from left to right, with the worst
status being shown on the left side of the view.
Clicking an object shows everything related to that object by fading unrelated objects, as shown:
1013
Clicking Spotlight removes the faded, unrelated objects from the view entirely.
Clicking the selected object at the top, or double-clicking it in the view, takes you to the Details page for
that object for further investigation.
1014
AppStack categories and data
The following matrix outlines all of the categories associated with the AppStack Environment view.
Different categories are available with each SolarWinds product, as indicated with the check mark.
Transactions A transaction is a
recording of web
browser steps
assigned to a specific
location.
1015
Servers A server is a computer
capable of accepting
requests from the
client and giving
responses accordingly.
The server makes
services, as access to
data files, programs,
and peripheral
devices, available to
workstations on a
network.
1016
particular body of
knowledge or
pertaining to a
particular business.
1017
partition of a hard
disk.
NAS Volumes Network-attached
storage (NAS) is a type
of dedicated file
storage device that
provides local-area
network (LAN) users
with centralized,
consolidated disk
storage through a
standard Ethernet
connection.
1018
Pools A storage pool (also
called a RAID array) is
a collection of disk
drives that become a
logical entity. When
you create a storage
pool, you select the
desired capacity
(number of disk drives)
and assign a RAID level
to it which provides a
redundancy level.
A VServer securely
isolates the shared
virtualized data
storage and network,
and appears as a
single dedicated
server to its clients.
Each VServer has a
separate administrator
authentication domain
and can be managed
independently by a
VServer administrator.
1019
In a cluster, a VServer
facilitates data access.
A cluster must have at
least one VServer to
serve data. VServers
use the storage and
network resources of
the cluster. However,
the volumes and LIFs
are exclusive to the V-
Server. Multiple
Vservers can coexist in
a single cluster
without being bound
to any node in a
cluster. However, they
are bound to the
physical cluster on
which they exist.
1020
Understand status and colors
Objects in the AppStack Environment view are colored based on their current status, providing you a quick
summary of your environment. Objects will be in one of the following states, represented by its icon's color
and shape that corresponds to the following table:
Down Red
Critical Pink
Warning Yellow
Unknown Gray
Unreachable Black
Up Green
Other Blue -
External Purple -
Statuses only become available for filtering when an object in your environment is in that state. For
example, if no objects have a status of Down, the Down status will not be available when filtering.
Status reporting
Servers can only provide an Up or Down status. To check CPU, memory, or hardware health status, hover
the mouse over the server icon to view the detailed tooltip. The reported status for applications and LUNs
is based on performance thresholds.
The AppStack Environment view offers a parent/child relationship. (Parents can be either servers or hosts.)
This relationship is represented as a mixed icon. The parent is the larger of the two icons that is hosting
the child. For example, the following illustration graphically shows that an application (child) is Down on a
node (parent) that is Up.
1021
Understand Quick Links
The Quick Links bar allows you to quickly open and close all visible object categories. Additionally, you can
toggle whether or not to show the names of objects that have a distressed status.
n Expand All: Opens all categories, revealing the visible objects within each category. Each category
can be individually expanded and collapsed by clicking [+] and [-] next to the category name.
n Collapse All: Closes all categories, hiding the objects within each category. Each category can be
individually expanded and collapsed by clicking [+] and [-] next to the category name.
1022
n Show/Hide Names: Allows you to toggle between showing and hiding the names for each object
that is in a distressed state. If more objects exist than are allowed to be displayed on the screen, the
category name will display the number of displayed objects followed by the total number of objects.
For example, (87 of 111), meaning only 87 objects of 111 total objects in this category are being
displayed. This provides a numerical summary of your environment. Clicking More (located after the
last visible object in the category) will display, by default, an additional 50 objects that are hidden
from view. Related objects may be found by clicking More. The default number of 50 can be changed
in the Settings page.
1023
Understand Categories
By default, the following AppStack Environment categories are available within Server & Application
Monitor.
n Groups
n Applications
n Servers
n Virtual Hosts
n Virtual Clusters
n Virtual DataCenters
n Virtual Centers
n Volumes
Other Orion products offer additional categories. Empty categories can be hidden via the Change
Layout Settings option in the drop down menu.
The Category Status Summary (located to the right of each category) parses, enumerates, and displays the
number of objects in a given category, emphasizing the status as indicated by the colors. The Category
Status Summary can be toggled to either be displayed at all times, or only when categories are collapsed.
This option exists under the Change Layout Settings settings drop down option.
If no objects in a category exist with a particular status, that status is not shown in the summary.
1024
Understand the Overview bar
The Overview Bar summarizes your environment in a compact space. If your view is currently filtered, the
filtered objects will be displayed above the Overview Bar, as shown. Individual filtered objects
The doughnut chart in the Overview section graphically displays the ratio of objects to one another in all
possible states using indicative colored slices. The total number of objects in your environment is also
displayed.
Objects under the Issues header are parsed and enumerated according to status. Objects shown here will
be in one of the following distressed states: Down, Critical, Warning, Unknown and Unreachable. An icon
and count will only appear if at least one object is currently in that state.
1025
Understand filtering options
By default, every object is displayed when you enter the AppStack Environment view. If you are concerned
only about objects with a certain status, you can filter the view by selecting one or more statuses and then
applying the filter. Additionally, you can filter objects based on various properties, as well as one or more
keywords. The illustration below details each tool and feature of the filtering sidebar:
Statuses only become available for filtering when an object in your environment is in that state. For
example, if no objects have a status of Down, the Down status will not be available when filtering.
1026
Understand filter properties
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click My Dashboards > Environment, and then click [+] Add Filter Properties.
2. From the pop-up menu, select an object from the Orion Object drop down list:
Note: Multiple items can be added.
3. When done, click Add column. The new filter appears in the filter column, as shown:
1027
If no relations are shown in the AppStack resource on the Group Details view, then it is likely that
this group contains no objects represented within the AppStack, such as switches, routers, and so
on. If you have created a group that contains only objects which have no representation within the
AppStack environment (e.g.: Nodes that are switches, routers, wireless access points, interfaces, and
so on) then they will not have relationships and the only item displayed within the AppStack
resource on the Group Details view is the group itself. This is normal behavior. Servers and virtual
servers are the only node types that are represented within the AppStack environment. Groups
made up of other object types which are not supported by the AppStack environment will not
appear within the AppStack resource.
1028
Understand layouts
A Layout is a user-defined filter (view-limitation), along with settings, that can be saved and recalled later
within the Appstack Environment view. User-defined layouts can be used to tailor the AppStack
Environment view to specific objects of interest. A default layout is provided and contains all objects visible
in the AppStack Environment that is currently being monitored. The default layout cannot be modified.
New layouts are created by first filtering your environment, and then saving the changes via the Save As
New Layout action in the Layout menu.
For example, to create a Layout where only IIS objects in the AppStack Environment view are shown, add
the IIS filter property, apply the filter, then save it as a new layout, naming the layout appropriately.
Once saved, the layout is added to the drop down menu, allowing you to easily navigate to that layout with
its defined filter and settings. The dot to the left of the name of the layout in the menu represents the
layout currently in use, as shown:
1029
Modify settings of a saved layout
1. Click Change Layout Settings from the drop down menu.
2. Click Save (or Save as New Layout...).
Select the layout from the drop down menu and then click Delete this Layout.
1030
Understand the AppStack resource
The full AppStack Environment view is designed to provide you with a powerful layer of troubleshooting
visibility by exposing all participating objects in your environment, as well as their relationships to one
another. By comparison, the AppStack resource only displays objects related to the target of the current
Details page.
In essence, this resource displays the related objects you would see in the full AppStack Environment view
after an object had been selected and then highlighted by clicking, Spotlight.
1031
Customize the AppStack Environment view
Administrators can customize this view by clicking Change Layout Settings in the Layout drop down menu
of the AppStack page.
1032
The Template and Application relationship
The following illustration explains the Template and Application relationship and is true for all templates,
including all AppInsight applications.
Here you can see that if you change something at the template level, the applications based on that
template are affected. Conversely, if you change something on the application level, only the individual
application are affected.
This inheritance relationship is beneficial if you need to make a great deal of changes quickly. For example,
rather than change one item on 100 applications that are based on a single template (which requires 100
changes), you can more easily change the one item on the template. That one change in the template
trickle down to all 100 applications that are based on the template.
1033
Understand component monitors
Component monitors are the building blocks of SolarWinds SAM. Each monitors the status and
performance of a different aspect of an application. Managing components can be achieved using the
commands on the SAM Settings page.
1034
View the component monitor library
The component monitors in the library are grouped by monitor type in the tree view display. For each
component monitor, two numbers are displayed.
n The first number represents the number of Application Monitor templates that contain the specified
component monitor.
n The second number represents the number of Application Monitors that contain the specified
component monitor.
Expanding a category displays the names of the templates or Application Monitors for the category,
respectively. Clicking the name of a template or Application Monitor takes you to a page where you can
edit that item.
1035
Choose component monitors and templates based on protocol
If you have a choice between components or templates that return the needed value using different
protocols, consider the following guidelines for making your choice, based on the protocol:
1. SNMP is the best protocol to use from the reliability and speed perspective. It is much faster and
more reliable than both Performance counters and WMI, and it has lowest impact on system
performance.
2. WMI calls can sometimes take a relatively long time, and they have a significant overhead.
The reason some SAM templates only use RPC is primarily customer demand. RPC is generally considered
more reliable. It also uses less overheard making it faster than WMI and it is firewall friendly. There are
distinct advantages and disadvantages to both RPC and WMI, which is why SAM utilizes both methods
for retrieving information.
1036
Monitor external nodes
To monitor services and applications on a server you do not directly manage, add the server to the Orion
database as an external node. External nodes skip all network performance data collection and polling
tasks, but allow you to assign applications to them.
For example, you could add www.google.com as an external node, and then assign several HTTP monitors
to monitor Google search results.
1037
Application availability and status
On any given poll, an application’s availability is either 100% or 0% based on the status of the
application. Availability is 100% if the application status is available, warning, or critical. For any other
status on that poll, SAM marks the availability at 0%.
The status of an application is determined by the worst status of the individual component monitors for
that application. For example, if one component for an application is down, then the application is marked
as down. If one component is in a warning state and the rest of the components are up, then the
application is given a warning status.
With respect to how an application’s availability is calculated over time, SAM aggregates the availability
values to Hourly/Daily tables during database maintenance, which is how the average is calculated.
Availability for component monitors is calculated in the same way.
1038
Charts in the SolarWinds web console
Clicking any chart opens the Custom Chart view in a new window, displaying the selected chart with
additional chart customization options.
You can also configure any custom chart resource in the SolarWinds Web Console directly from the
resource title bar either by selecting from the drop down menu of options or by clicking Edit to display the
Edit Chart Title view, as described in the following sections.
Chart Information
n If SAM is upgraded to version 6.0 or higher, legacy charts already assigned to views will be
upgraded.
n Charts from earlier versions of SAM will be renamed to have the prefix "Legacy" and must be added
manually.
The title bar menu of the custom chart resource provides the following options for viewing chart data:
n View chart data over the Last 7 Days or over the Last 30 Days
n Select Edit Chart to view and modify chart settings.
Note: This is the same as clicking Edit in the title bar.
n View Chart Data as an HTML format document
n View Chart Data in Excel to see chart data in an Excel™-compatible format
Click Edit in the title bar of a custom chart resource to display the Edit Chart Title view. This view provides
the following options to configure your chart resource:
Select a Chart allows you to change the chart type displayed in the current resource. Chart options are
determined in accordance with the type of view displaying the resource you are currently editing.
The Time Period for the selected chart may be any of the following:
The Sample Interval for the selected chart may be any of the following:
1039
Notes:
n Each sample interval is represented on a chart by a single point or bar. Data within a selected
sample interval is summarized automatically.
n Due to limits of memory allocation, some combinations of time periods and sample intervals require
too many system resources to display, due to the large number of polled data points. As a result,
charts may not display if the time period is too long or if the sample interval is too small.
The Trend Line option allows you to enable the trend line feature of SolarWinds SAM charts. By enabling
trend lines on SolarWinds SAM charts, you can see potential future results as they are extrapolated from
collected historical data.
Due to the broad array of factors that can affect the performance of devices on your network, trend
lines provided on SolarWinds SAM charts are intended as approximate predictions of future data
only.
1040
The Windows Scheduled Task Monitor
The Windows Scheduled Task Monitor (WSTM) is a resource designed to provide you with quick visual
access to the status of scheduled tasks configured on your Windows nodes.
Only tasks from root directory can be monitored. The WSTM will not work for tasks from every level
of the Task Scheduler Library.
The WSTM comes with an alert that will notify you of any task execution failures, as well as web-based
reports that show all scheduled tasks configured across all servers in your environment. Additionally, there
is a dedicated Task Failure Report you can view on-screen or have emailed to you.
This resource is hidden when the WSTM is not being monitored on a node.
1041
The Real Time Event Log Viewer
View Windows event logs in real time using the WMI protocol with the Real Time Event Viewer (RTEV). Event
logs can be filtered by log type, event source, and the level of severity. You can also select which event logs
you want to monitor from within this resource.
1042
The Real Time Process Explorer
The Real Time Process Explorer (RTPE) is available for WMI and SNMP monitored nodes. The advantage of
the RTPE is that you no longer need to physically or remotely log in to a computer and run the Task
Manager to retrieve that machine's vital statistics. Information for monitored and unmonitored processes
is displayed directly through SAM using the RTPE.
Notes:
n Only SAM administrators can end processes as well as enable and disable the RTPE.
n The User Name and Command Line columns are hidden by default.
n Using the RTPE on a node monitored via ICMP, which has no working component, requires you to
select Windows credentials manually. Consider promoting the selected node to SNMP or WMI to
avoid this prompt.
1043
The Service Control Manager
The Service Control Manager (SCM) is similar to the Real Time Process Explorer, except with the SCM you
manage the services of monitored Windows nodes instead of processes. The advantage of the SCM is that
you no longer need to physically, or remotely, log in to a Windows computer to view and control its
services. Information for running and stopped services is displayed directly through SAM using the Service
Control Manager.
Services viewed in the Service Control Manager are polled every 25 seconds using WMI.
SAM can also monitor the health of the following Server Blade Chassis without the need for additional
software:
n HP C7000
n HP C3000
n Dell M1000e
Hardware monitoring is achieved by polling via SNMP or WMI, depending upon the node. For SNMP and
WMI nodes, hardware monitoring must be enabled manually through SAM's web console.
If you run a scheduled Network Sonar Discovery of your existing servers, SAM automatically collects
any servers that support hardware health information the next time the discovery runs.
Monitoring your hardware's health does not count against your allotted licenses.
1044
Enable hardware health monitoring
When you add nodes using Network Sonar Discovery, the hardware health sensors are enabled for
devices that support hardware health monitoring automatically.
When adding individual nodes with the Add Node wizard, you can enable or disable hardware health
monitoring in the wizard.
To verify that hardware health statistics are being collected, list monitored resources for the node and
ensure that hardware health monitoring is enabled.
When selecting resources for monitoring a node in the Add Node wizard, select the Hardware Health
Sensors box to enable hardware health monitoring.
Hardware health statistics for enabled hardware sensors are collected for the node.
1045
Change hardware health temperature units
The selected unit will be applied in all hardware health resources in the Orion Web Console. This setting is
user-specific, and it is connected with your user account.
You can also access the temperature unit setting when editing a user in the Hardware Health
Package Settings.
1046
Edit hardware health thresholds
Hardware states displayed in the Orion Web Console change based on thresholds set for the sensors. You
can either use thresholds available on the device, set a sensor to always appear to be up, or customize
thresholds.
When values polled on a node reach the threshold value, an event triggers together with the alert
"Hardware is in warning or critical state."
1. Go to Manage Hardware Sensors view (Settings > All Settings > Node & Group Management >
Manage Hardware Sensors).
2. Select the sensor that you want to edit, and click Edit Thresholds.
To find all sensors available on a node, select Node in the Group By list, and select the node.
3. Select how you want to change the selected hardware sensor's status:
Use Orion Defaults
Use thresholds configured on the device. This is the default setting.
Force to Up
If you are not concerned about a sensor, select this option. The sensor will always be displayed
as UP, ignoring the real data from the sensor.
Set Custom Thresholds
Use the dynamic query builder to define the status for the selected sensor.
4. Click Submit.
The status of the hardware health sensor will now be governed by the specified threshold.
1047
Agents
Certificates and the agent
The Verisign Root Certificate Authority (CA) must be current. This is required because the agent software is
signed using a Verisign certificate. If your certificate is not current, you must download the Root CA
certificate and install it to the Local Computer\Trusted Root Certification Authority store on
the server hosting the agent.
For more information, search for "Add the Certificates Snap-in to an MMC" at technet.microsoft.com.
1048
Agent performance counters
SolarWinds: Agent Service
NAME DESCRIPTION
Messages Sent The number of messages sent to the Agent Management Service.
Messages Received The number of messages received from the Agent Management Service.
Exchange Received The number of times the Exchange Receive method was called.
Exchange Sent The number of times the Exchange Send method was called.
NAME DESCRIPTION
Messages Sent to Agent Count The number of messages sent to the agent.
Incoming Timed Out Messages The number of incoming messages that timed out before being
Count processed by the recipient.
Outgoing Timed Out Messages The number of outgoing messages that timed out before they were
Count sent to the target agent.
Total Agents Fully Connected The number of total agents fully connected.
Active Agents Fully Connected The number of active agents fully connected.
Passive Agents Fully Connected The number of passive agents fully connected.
1049
NAME DESCRIPTION
Incoming Messages Processed
The number of incoming messages processed per second.
per Second
Incoming Exchange Queue Size The number of messages in the incoming queue with Exchange items.
1050
Viewing and customizing application and component
performance and status
The following sections provide a short list and overview of the views and resources provided with Server &
Application Monitor that reveal performance and status information:
n Volume details
n Understand interface details
n View event details in the web console
n Understand component monitors and application monitor templates
n Available data transformations
n Web service monitoring
1051
Volume details
SAM has the ability to monitor Disk Volume with great detail. Windows mount points are treated as
regular volumes. Monitoring mount points can only be done on nodes that are monitored via WMI
You may need to log in with an administrator account to perform this action.
You may need to log in with an administrator account to perform this action.
1052
Understand interface details
SAM offers the added ability to monitor Windows based interfaces using WMI.
The Interface Details page comes with a variety of resources and charts that provide details about the
interface being monitored. Most are self-explanatory. Those that are not are listed below:
Using the Enterprise Operations Console (EOC) with a standalone version of SAM 5.5 or earlier will not
allow interfaces to be monitored via WMI. For more information, refer to the following KB article:
https://support.solarwinds.com/?title=Success_Center/Server_%26_Application_Monitor_(SAM)
/Monitored_interfaces_are_not_displayed_in_EOC_with_standalone_SAM_5.5
1053
View event details in the web console
SolarWinds logs network events and lists them in the readily customizable Events view of the Web Console.
Events are shown in order of occurrence, and they may be viewed by device, date and time, and event or
device type.
You may need to log in with an administrator account to perform this action.
The Network Event Log is maintained as part of the Nightly Database Maintenance plan defined
within the Database Settings area of the SolarWinds Polling Setting page in the SolarWinds Web
Console. Records are kept for the number of days specified Events Retention field (the default is 30
days).
1054
Understand component monitors and application monitor templates
The following terms are used throughout this guide to describe the SolarWinds SAM concepts that allow
you to monitor your applications.
Component Monitors
Component monitors are the building blocks of SolarWinds SAM. Each monitors the status and
performance of a different aspect of an application. There are several different types of component
monitors, each containing settings that define what is monitored and how to monitor it.
Some types of component monitors allow you to set threshold conditions on the monitored
parameters. You can set separate thresholds to indicate warning and critical conditions. For
example, if you are monitoring the percentage of free space remaining on a volume, you can set a
warning threshold at 15%, and a critical condition at 5%.
As an analogy, pretend SolarWinds SAM is monitoring a car. You would have component monitors to
check tire pressure, engine RPM, water temperature, battery voltage, and other important
subsystems of that vehicle. You can set alerts to give notification if the water gets too hot, or if the
battery voltage drops too low.
A template is a group of component monitors modeling the total availability and performance level
of an application. A complicated application such as Windows Server may require dozens of
component monitors to accurately assess its current status and performance.
Instead of creating component monitors one-by-one for every application server, you can assign a
pre-made template. The template can either be one included with SolarWinds SAM, or a custom
template you make yourself. For example, you can assign the included Microsoft Windows Server
2003-2008 template to your Windows 2003 and Windows 2008 computers and obtain vital statistics
on all of them.
A template is only a blueprint and does not perform any monitoring on its own. Only after assigning
the template to a server node are active assigned component monitors created.
To continue the car analogy, pretend you want to monitor a fleet of 50, 2010, blue Dodge Charger
automobiles. Instead of defining the component monitors for 50 cars, you can define all the
component monitors in a Dodge Charger template.
Assigned component monitors are created by assigning Application Monitor templates to server
nodes. Each actively monitors its assigned node according to its settings. Component monitors
inherit these initial settings from the template. If you make a change to a template, that same
change is rolled out to all assigned Application Monitors based on the template.
1055
You can override the template settings at any time, breaking the inheritance relationship between
the component monitor and its template. For example, the user name and password usually differ
for each node, and you would select a different credential for each assigned Application Monitor,
thus overriding the template setting for the Credentials field.
To restore the inheritance relationship between a component monitor and its template, click Inherit
From Template next to the setting.
Continuing the car analogy, when you assign the Dodge Charger template to a Dodge Charger
vehicle, you now have a set of assigned component monitors for monitoring the vehicle’s tire
pressures, engine RPM, and so forth.
An assigned Application Monitor runs its assigned component monitors at regular intervals,
and then uses the status results from the component monitors to determine an overall status
for the application.
If some of the component monitors are up and others are down, the Application Monitor follows the
Status Rollup Mode setting in the SolarWinds Web Console Settings to show either the worst status
of the group or a warning status.
The difference between an assigned Application Monitor and a template is that the template is only
a blueprint and does not perform any monitoring on its own. Only after assigning the template to a
server node does SolarWinds SAM conduct any actual monitoring on the node.
To complete the car example, you assign the Dodge Charger template to all the Dodge Charger
vehicles to create the assigned Application Monitor for determining the overall status for your Dodge
Charger fleet. For example, the fleet may be 95% available at a given time due to warnings for some
of the cars.
1056
Available data transformations
SolarWinds SAM provides a number of predefined transformation functions that may be applied to one or
more monitors to generate mathematically manipulated results. The following table lists transformation
functions that are currently available in SolarWinds SAM:
1057
Kilobyte to KiloToMega Provides the number of Megabytes, originally
Megabyte ({value}) presented in Kilobytes
1058
Web service monitoring
For custom web services that need to be monitored, SAM offers the ability to utilize the following
technologies:
n JSON: JavaScript Object Notation (JSON) is an open standard format that uses human-readable text
to transmit data objects consisting of attribute–value pairs. It is used primarily to transmit data
between a server and web application, as an alternative to XML.
Note: Inserted JSON content cannot exceed 1MB in size.
n SOAP: Simple Object Access Protocol (SOAP) is a protocol used for exchanging information in the
implementation of web services in computer networks. It relies on XML for its message format, and
usually relies on other application layer protocols. The SOAP monitor is useful if you have custom
web services that need to be monitored.
Currently, the SOAP monitor within SAM can return a status of either Up or Down, or return a
status of Warning or Critical based on response time thresholds. This monitor also has the ability
to search for the presence of a string.
n JSON
n SOAP Monitor
n Configure the SOAP monitor
1059
JSON
{
"firstname": "Kate"
"lastname": "Asaff"
"age" : 29
"city" : "Austin"
}
Inserted JSON content cannot exceed 1MB in size. SolarWinds Technical Support does not provide
support for custom scripts.
1060
SOAP Monitor
Definitions
n SOAP: (Simple Object Access Protocol) is a protocol used for exchanging information in the
implementation of web services in computer networks. It relies on XML for its message format, and
usually relies on other application layer protocols, most notably Hypertext Transfer Protocol (HTTP).
n WSDL: (Web Services Description Language). The Web Services Description Language is an XML-
based interface description language that is used for describing the functionality offered by a web
service.
n XML: Extensible Markup Language is a markup language that defines a set of rules for encoding
documents in a format that is both human-readable and machine-readable.
You can test the SOAP monitor in Edit mode. If the test poll throws a web exception (indicating that there
was a problem on the target) the response content is extracted and you are able to view the message to
help identify the issue.
Currently, the SOAP monitor within SAM can return a status of either Up or Down, or return a
status of Warning or Critical based on response time thresholds. This monitor also has the ability
to search for the presence of a string.
1061
Configure the SOAP monitor
Load WSDL Files
The SOAP monitor within SAM currently supports the WSDL schema, which must be exposed on a URL.
Once the WSDL file is successfully loaded, the file is parsed automatically and the fields, highlighted
below, populates. Once the WSDL file has been successfully loaded, you can specify values for the
available arguments. There are two types of arguments, simple, and complex.
A simple argument is one where you can define the value directly. A complex argument (e.g. structures,
classes, list, and so on) must be user-defined in the XML format. It is recommended that complex
arguments be used only by experienced users.
The Advanced Settings are read-only and displays additional information. Because the SOAP
envelope is based on the WSDL schema, the Advanced Settings values should not be changed.
The SOAP XML field contains the SOAP envelope which is generated by the WSDL and dynamically
changes as you make changes to the SOAP settings. In this field you can check what is to be sent to the
web service.
Important: If changes are made to any of the base SOAP settings, the content of the SOAP XML is
re-generated and your changes become lost.
1062
Manually Enter XML
The following is an example of a Complex argument and would be placed in the Parameters field.
SAM automatically takes the code and place it where it belongs in the envelope:
<tempPhoneNumber
xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"
xsi:type="ns2:Array" ns2:arrayType="ns1:TemporaryPhoneNumber[3]">
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37060</startDate>
<endDate xsi:type="xsd:int">37064</endDate>
1063
<phoneNumber xsi:type="xsd:string">+1-212-5551234</phoneNumber>
</item>
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37074</startDate>
<endDate xsi:type="xsd:int">37078</endDate>
<phoneNumber xsi:type="xsd:string">+1-212-5554321</phoneNumber>
</item>
<item xsi:type="ns1:TemporaryPhoneNumber">
<startDate xsi:type="xsd:int">37088</startDate>
<endDate xsi:type="xsd:int">37092</endDate>
<phoneNumber xsi:type="xsd:string">+1-212-5557890</phoneNumber>
</item>
</tempPhoneNumber>
1064
View the Asset Inventory dashboard
The Asset Inventory Dashboard is comprised of various resource modules and provides detailed insight
about the selected asset. The dashboard information can be found on a separate sub-view tab.
You may need to log in with an administrator account to perform this action.
All Asset Inventory resources contain a blue icon in the upper left-hand corner of the resource. This
will allow you to better identify this as an Asset Inventory resource should you decide to place
individual resources on different views.
Both the titles and subtitles of each resource can be changed by clicking Edit in the upper right-hand
corner of any resource.
Resources for the Asset Inventory dashboard can be added and deleted by clicking Customize Page in the
upper right-hand corner of the web console.
n If no information can be collected for a particular resource, that resource will become hidden for
that node.
n Clicking the title of any resource will open that resource in a new window.
1065
Custom Asset Information
This resource displays custom properties you have created relating to Asset Information.
1066
Drivers
This resource displays driver software currently installed on the current node while providing a search
window. The data can be sorted by clicking the headers of each column.
1067
Firmware
This resource displays the firmware currently installed on the current node while providing a search
window. The data can be sorted by clicking the headers of each column.
1068
Graphics and Audio
This resource provides detailed information about the current graphics and audio devices associated with
the node.
In systems that contain multiple video cards or monitors, only the first of each will be displayed in
the Graphics and Audio resource for that node.
1069
Hard Drives
This resource provides information about the current hard drives associated with the node.
1070
Hosted Virtual Machines
This resource details the amount of resources allocated to each virtual machine. Both VMware and Hyper-V
hosts can be displayed in this resource.
1071
Logical Volumes
This resource provides detailed information about the current logical volumes associated with the node.
Volumes call be polled via all protocols except VMware CIM for ESX hosts. Any logical volume that can be
monitored by SolarWinds appears in this resource.
1072
Memory
This resource provides detailed information about the memory associated with the node.
Memory Summary
n Total RAM: Displays the total amount of RAM on the current node.
n Free RAM: Displays the total amount of free RAM on the current node.
n Total Virtual Memory: Displays the total amount of virtual RAM on the current node.
n Free Virtual Memory: Displays the total amount of free virtual RAM on the current node.
Memory Modules
n Slot: Displays the slot number in the server where memory is installed. SAM also shows empty slots
that could be populated with additional memory modules to increase the server's RAM.
n Capacity: Displays the maximum available RAM installed in the current memory slot, in megabytes.
n Model: Displays the model part number which can be used for purchasing a replacement part.
n Speed: Displays the frequency on which the memory module runs, in megahertz.
1073
Network Interfaces
This resource provides detailed information about current network interfaces associated with the node.
n Name: Displays the name and model of the listed interface. For more information about a network
interface, click [+] to the left of the interface name to expand the tree view and reveal the following
information:
n NetMask: Displays the configured netmask.
n Gateway: Displays the address of the gateway.
n DHCP Server: Displays the address of the DHCP server.
l Manufacturer: Displays the manufacturer of the listed interface.
l MAC Address: Displays the MAC address of the listed interface.
l IP Address: Displays the IP address of the listed interface.
1074
Operating System Updates Applied
This resource displays operating system updates that have been applied on the current node while
providing a search window. The data can be sorted by clicking the headers of each column.
This resource is only visible for Windows Nodes polled via WMI
n Name: Displays the name of the listed update. Clicking the name in this field may take you to the
website with information concerning the listed update.
n Type: Displays the type of update installed.
n Install Date: Displays the date that the listed update was installed.
n Installed By: Displays the user responsible for installing the listed update.
1075
Out of Band Management
This resource provides details about out of band management controllers installed on the node.
1076
Peripherals
This resource provides information about the current peripherals associated with the node.
1077
Ports and USB Controllers
This resource provides detailed information about the current ports and USB controllers associated with
the node.
Ports
USB Controllers
n USB Controllers: Displays detailed information about the listed USB controller.
1078
Processors
This resource provides detailed information about the processors associated with the node.
Notes:
n Some IBM nodes may not provide processor information which results in missing information from
this resource.
n If a monitored computer is running the Solaris operating system, processor information will not be
available in this resource.
Important: Data for the number of cores will not be available for computers running Windows
Server 2003 unless the following Microsoft hotfix is applied:
http://support.microsoft.com/kb/932370.
1079
Removable Media
This resource provides information about the current removable media associated with the node.
1080
Software Inventory
This resource displays software currently installed on the current node while providing a search window.
1081
Storage Controllers
This resource provides detailed information about the current storage controllers associated with the
node. The data can be sorted by clicking the headers of each column.
1082
System Information
This resource provides a general overview of the selected node. To update the details of this resource, click
Poll Now, which forces all Asset Inventory information to be polled immediately. To navigate to the Node
Details page of the current node, click the name of the node in the System Name field.
1083
1084
When the listed machine is on Microsoft Hyper-V virtual hardware, certain fields are populated with
virtual machine related information. Because SAM collects physical enclosure information from this
class when using WMI, the following fields may read as follows:
General
n Last Inventory Collection: The date when SAM last collected inventory data on the selected node.
n System Name: Name of the current node.
n Host Name: Name of the current host. This only applies to Windows hosts polled via WMI
n Domain/Workgroup Name: Name of the domain or workgroup this node belongs to.
n DNS: This is the DNS name of the current node. The IP address of the node can change while the
DNS name remains the same.
n Domain Role: Shows the role of the current node. This only applies to Windows hosts polled via
WMI
n IP Address: Shows the IP address of the current node.
n Dynamic IP: Shows if the current IP address is dynamic or static.
Hardware
1085
Operating System
1086
Windows Update Information
This resource provides information about the current Windows update status associated with the node.
This only applies to Windows nodes polled via WMI.
1087
SolarWinds SAM Charts and Resources
Following is a list of the available charts within SAM:
1088
Application Availability Chart
This chart lets you visualize the amount of time an application was in a particular state of availability. This
chart is interactive. Hover over any part of the chart to display detailed information.
The tooltip indicates the number of times the application was in a certain state. For example, in the
previous illustration, an application was polled 12 times in one hour (every five minutes) and was deemed
available (up) 10 times, in a Critical state once, and in a Warning state once.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons; 1 hour, 12 hours, or 24 hours. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
1089
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
The Export button opens the Custom Chart allowing you to export this data to both MS Excel and
HTML.
1090
Custom Chart
The Custom Chart resource allows you to easily view data based on your needs. To customize it, click Edit
in the upper right corner of the resource.
From the Edit page, you can define the titles, datasource, time period, labels, units displayed, the type of
chart to be used, and an optional sum of the data.
1091
9. Clicking More allows you to customize further by optionally changing the Display Name, Color,
showing the 95th percentile, and trend line.
10. Optionally repeat Steps 5 - 9 for the Y axis on the right side of the chart.
11. Select a Sample Interval from the drop down list.
12. Optionally filter the results from the options provided.
13. When done, click Submit.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
1092
Custom Area Chart
The Custom Area Chart resource allows you to easily view data as shown in percentage format. To
customize it, simply click Edit in the upper right-hand corner of the resource.
Use the check box in the legend as a toggle to show/hide data on the chart. Clicking Export lets you export
the data to either an HTML or Excel file.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
1093
Custom Bar Chart
The Custom Bar Chart resource allows you to easily view data as shown in percentage format. To
customize it, simply click Edit in the upper right-hand corner of the resource.
Use the check box in the legend as a toggle to show/hide data on the chart. Clicking Export lets you export
the data to either an HTML or Excel file.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
1094
Component Availability Chart
The Component Availability Chart is a straightforward bar chart that provides a visual representation of
the percentage of availability of a selected component.
Clicking Edit will provide a menu of components to choose from to have represented on the chart, as the
following illustration depicts:
This option is only available on the Application Details page and not the Component Details page.
Clicking the chart itself, as opposed to the Edit button, brings up additional, self-explanatory
options.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons; 1 hour, 12 hours, or 24 hours. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
1095
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
The Export button will allow you to export this data to both MS Excel and HTML.
1096
Custom Chart View
Charts in the SolarWinds Web Console are easily customizable. Clicking a chart opens the Custom Chart
view in a new window. The following sections describe options that are available on the Custom Chart
page to modify the presentation of a selected chart.
Printing Options
To print your customized chart, click Printable Version and a printable version of your
customized chart displays in the browser.
Chart Titles
Chart Titles are displayed at the top center of a generated chart. The Chart Titles area allows
you to modify the Title and Subtitles of your generated chart.
Note: SolarWinds may provide default chart titles and subtitles. If you edit any of the Chart
Titles fields on the Custom Chart page, you can restore the default titles and subtitles by
clearing the respective fields, and then clicking Submit.
Time Period
Predefined and custom time periods are available for generated charts. You may designate the
time period for a chart by either of the following methods:
Sample Interval
The sample interval dictates the precision of a given chart. A single point or bar is plotted for
each sample interval. If a sample interval spans multiple polls, data is automatically
summarized and plotted as a single point or bar on the chart.
Note: Due to limits of memory allocation and the large number of polled data points, some
combinations of time periods and sample intervals may require too many system resources to
display. As a result, charts may not display if the time period is too long or if the sample
interval is too small.
Chart Size
Chart Size options configure the width and height, in pixels, of the chart. You can maintain the
same width/height aspect ratio, or scale the chart in size, by entering a width in the Width field
and then entering 0 for the Height.
Font Size
Font sizes for generated charts are variable. The Font Size option allows you to select a Small,
1097
Medium, or Large size font for your chart labels and text.
Note:Font Size selections are maintained in the printable version of your chart.
The Display Data from Chart area provides the following options to export chart data as either
Excel-compatible Raw Data or as HTML-formatted Chart Data:
n To view chart data in an Excel-compatible format, click Raw Data, and then follow the
prompts, if provided, to open or save the resulting raw data file.
n To view HTML-formatted chart data in a new browser, click Chart Data.
1098
Custom Line Chart
The Custom Line Chart resource allows you to easily view data as shown in percentage format. To
customize it, simply click Edit in the upper right-hand corner of the resource.
Use the check box in the legend as a toggle to show/hide data on the chart. Clicking Export lets you to
export the data to either an HTML or Excel file.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons in the head of the Zoom column. Alternatively, you can have the chart show a specific date range
by dragging the mouse over an area of the chart. The time and date displayed at the top of the resource
shows the amount of data currently loaded into the chart. This can be changed by clicking Edit from within
the resource.
1099
Custom Query resource
The Custom Query resource allows you to create a custom resource based on a SolarWinds Query
Language (SWQL) query. The query provided in this resource is run against your SolarWinds database, and
the results are displayed in an appropriate grid.
Clicking Edit allows you to configure your Custom Query resource, as indicated in the following procedure.
1100
Custom Table
The Custom Table resource allows you to easily view data that can be customized to suit your needs. To
customize it, click Edit in the upper right-hand corner of the resource.
Once in Edit mode, You can select and adjust the following options for this resource:
n Title and subtitle: Used to change the labels of the Title and Subtitle.
n Datasource: This lets you to create queries and add conditions. When you add a condition, you
have the option to add a field or use pre-existing fields. Your choices are reflected in the Custom
Table resource once it has been updated.
n Time Period: Select the time period for data to be displayed in the resource.
n Table Layout: Once a Datasource is selected, you can add columns and then arrange them by
dragging them into position. Clicking [X] deletes the column from view.
n Sort Results: Allows you to choose how the data is sorted and displayed.
n Group Results: Allows you to choose how the data is grouped.
n Filter Results: Allows you to choose how many records are displayed based on either a set number
or a percentage.
1101
Custom Node Charts
The following node-related charts, grouped by type, are available as resources within the SolarWinds Web
Console. To add any of these charts to a web console view dealing with monitored nodes, add the Custom
Node Chart resource to the Node Details view.
Availability
The following charts are available to display node availability information over custom time periods for
nodes monitored by SolarWinds.
n Availability
n Availability - Autoscale
n Availability and Response Time
CPU Load
The following charts display CPU loading information over specified periods of time for nodes monitored
by SolarWinds.
Memory Usage
The following charts present memory usage information over custom time periods for nodes monitored by
SolarWinds.
The following charts are available to display historical statistics about packet loss and response time for
nodes monitored by SolarWinds.
1102
Custom Volume Charts
The following volume-related charts, grouped by type, are available as resources within the SolarWinds
Web Console. To add any of these charts to a web console view dealing with monitored volumes, add the
Custom Volume Chart resource to the Volume Details view.
Allocation Failures
Shows the number of disk allocation failures that have occurred on the selected volume.
Shows both the total disk space available and the average amount of disk space used on the selected
volume. Bars are also included to show minimum and maximum levels of disk usage.
Shows the total available disk space and the average amount of disk space used, as a percentage of
the total available, on the selected volume.
Volume Size
1103
Event Log Message Details
The Event Log Message Details resource allows you to read each message of the event log in its entirety.
This resource is found on the Component Details page and can return the following information:
Clicking on Show More expands the resource to fill a separate screen. Clicking on any message in this
resource brings up the entire message that was created in the event log.
Alerts with this resource can be used with the complete message text of events.
1104
Min/Max Average Chart
The Min/Max Average Chart has been updated from previous releases to show more information and
provide more flexibility. These charts can be found by navigating to the Component Details page or the
Application Details page.
1. Navigate to the Component Details page or the Application Details page.
2. Click Customize Page.
3. Click the [+] in either column.
4. Select a category to group items by from the Group by drop down menu:
Note: The Classic category reflects the tree views found in previous versions of SAM for this
resource.
5. Select the charts you want, and then click Add Selected Resources.
6. Click Done.
This chart can be customized to view the following data by clicking the Edit button at the top-right of the
chart. The available data to this chart are as follows:
n CPU Load
n Physical Memory
n Virtual Memory
n Response Time
n Statistic Data
Clicking Edit also reveals several self-explanatory options. Clicking Export allows you to export the data to
both Excel and HTML formats.
This resource is made up of three sections: the toolbar, the main chart, and the lower chart. This allows
you to visualize the selected data by viewing the minimums, maximums, and averages of the data for a
selected time period.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons; 1 Day, 1 Week, or 1 Month, as highlighted in the above illustration. Alternatively, you can have the
chart show a specific date range by dragging the mouse over a small area of the chart, or by typing in
specific dates in the From and To fields, also highlighted.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders,
highlighted above. The main view of the chart will display the selected time period between the two sliders
of the lower chart.
1105
Moving the mouse over the main chart will reveal a tooltip with more detailed information about the
specific time period the mouse is hovering over.
By default, all statistics are shown in the main chart. You can add or remove any statistic from the chart by
checking and unchecking any statistic from the legend at the lower left of the resource.
1106
Multiple Object Chart
The Multiple Object Chart resource allows you to simultaneously view data for multiple objects on the
same chart. Objects may be on the same node or on different nodes. Clicking Edit allows you to configure
the characteristics of a selected multiple objects chart.
1. Once the chart is on your Home Summary page, click Edit.
2. From this page, you can have multiple options to choose from, including:
a. Title: This allows you to change the title of your chart.
b. Subtitle: This allows you to add a subtitle to your chart.
c. Choose Objects: This allows you to choose the type of objects to display from the drop
down menu provided. You can remove an object from the list by clicking the red X to its
right.
d. Select a Chart: This allows you to chart various aspects of what you intend to monitor.
e. Choose Objects: Click the Select SolarWinds Object button to choose which objects you
want charted based on your selection in step iii.
f. Limit Series: Checking this box and setting the number of series limits the number of
items displayed on the chart to the specified amount.
1107
g. Show Sum in Data Series: This allows you to chart the total of the other objects graphed
and is represented by its own plot line.
h. Time Period: This allows you to set the range displayed on the chart.
i. Sample Interval: This allows you to set the interval that this chart is updated.
1108
Multiple Statistic Chart
This chart provides the ability to graphically visualize multiple statistics simultaneously, as well as view the
statistics in the table below. The advantage of this view is that you can easily determine how certain
processes and services are performing in relation to others. For example, you may notice that a spike in
RAM usage results in higher CPU usage. This charted information allows you to get a quick overview of
what is being monitored and may answer why certain unexpected events are occurring.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons at the top of the chart. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
Once you have a time period selected, the lower chart zooms to the starting and ending values of the
selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders.
The main view of the chart displays the selected time period between the two sliders of the lower chart.
The Multiple Statistic Chart can be added to either the Application Details page or the SAM Component
Details page.
1. Drill down to either the Application Details page or the SAM Component Details page.
2. Click Customize Page on the far top right of the page.
1109
3. Click the green [+] to the right of the column in which you want to add this chart.
4. Select and expand SAM Charts - Historical charts for SAM.
5. Check Multiple Statistic Chart, and then click Submit, then click Done.
1. Once the chart is on your Details page, click Edit at the top right of the chart.
2. From this page, you can have several options to choose from, including:
1110
Multi Chart
This chart provides the ability to graphically visualize multiple statistics simultaneously at the application
level without the need to drill down into each component monitor.
The advantage of this view is that you can easily determine how certain processes are performing in
relation to others. For example, you may notice that a spike in RAM usage results in higher CPU usage. This
charted information allows you to get a quick overview of what is being monitored and may answer why
certain unexpected events are occurring.
Zooming
You can have the chart show a predetermined time period of data by clicking on any one of the three Zoom
buttons at the top of the chart. Alternatively, you can have the chart show a specific time range by
dragging the mouse over a small area of the chart, or by adjusting the sliders in the smaller chart below
the main chart.
The Multi Chart can be added from the Application Details page.
1. Once the chart is on your Application Details page, click either Edit, Select a chart, or
Configure this resource.
1111
2. From this page, you have several options to choose from, including:
ii) Subtitle: This allows you to change the subtitle of your chart.
iv) Show Thresholds: This allows Warning and Critical Thresholds to be displayed
as yellow and red bands, respectively.
v) Default zoom range: Allows you to choose the time period of data to be
displayed.
vi) Amount of historical data to load: Allows you to select the amount of
historical data to be displayed.
vii) Sample interval: Allows you to set the polling time for the components in this
chart.
1112
Reading the Application Summary view
The SAM Application Summary is the first view displayed after launching Server & Application Monitor.
This view provides insight into application health and performance conditions over your entire network.
The resources listed in this section are the default views included in the SAM Application Summary.
1113
Active application alerts
This resource provides the current application-specific alerts, including the time the alert fired, the name
of the application that caused the alert, and the alert message. Click the Network Node to see the
SolarWinds Node Details view. Click the Application Name to see the SAM Application Details view.
1114
Application Health Overview
This resource provides a status overview of all your assigned application monitors. Click a status to list the
assigned application monitors in that status.
Application Up
Assigned application monitors with all component monitors responding and operating within their
thresholds.
Application Critical
Assigned application monitors with at least one component monitor operating past the critical
threshold.
Application Down
Application Warning
Assigned application monitors with at least one component monitor operating past the warning
threshold.
Other
Unknown
1115
Applications with Problems
This resource lists the assigned application monitors reporting any status other than up.
1116
Last 25 Application Events
This resource provides a list of application-centric events from the time period you specify. The default
time period shows the last 25 application events. Click Edit to change the time period, limiting the events
displayed in the resource.
1117
Thwack Latest Application Templates
This resource lists the newest application monitor templates that have been added to the Thwack
community web site. Click a template to open its download web page.
1118
Top 10 Components Monitored by Response Time
This resource provides a list of the component monitors with the slowest response time.
1119
Top 10 Monitored Processes by CPU Load
This resource provides a list of the component monitors consuming the most CPU.
1120
Top 10 Monitored Processes by Physical Memory
This resource provides a list of the component monitors consuming the most physical memory.
1121
Top 10 Monitored Processes by Virtual Memory
This resource provides a list of the component monitors consuming the most virtual memory.
1122
Top 10 Monitored Processes by I/O Reads/Sec
This resource displays the total number of I/O Read operations per second.
Fields:
n Process Name: Displays the name of the listed process. Clicking a process in the list will take you to
the Component Details page for that process.
n Application Name: Displays the name of the listed application that contains the listed process.
Clicking an application in the list takes you to the Application Details page for that application.
n Network Node: Displays the name of the listed node that contains the listed application and
process. Clicking a node in the list takes you to the Node Details page for that node.
n IO Reads: Displays the current rate of Input/Output reads.
Clicking Edit lets you to change the Title, Sub-Title, and Maximum Number of Monitors to Display.
Hovering the mouse over any part of this resource reveals a tooltip with detailed information about the
item listed.
1123
Top 10 Monitored Processes by I/O Writes/Sec
This resource displays the total number of I/O Write operations per second.
Fields:
n Process Name: Displays the name of the listed process. Clicking a process in the list takes you to
the Component Details page for that process.
n Application Name: Displays the name of the listed application that contains the listed process.
Clicking an application in the list takes you to the Application Details page for that application.
n Network Node: Displays the name of the listed node that contains the listed application and
process. Clicking a node in the list takes you to the Node Details page for that node.
n IO Writes: Displays the current rate of Input/Output writes.
Clicking Edit lets you to change the Title, Sub-Title, and Maximum Number of Monitors to Display.
Hovering the mouse over any part of this resource will reveal a tooltip with detailed information about the
item listed.
1124
Top 10 Monitored Processes by I/O Total Operations/Sec
This resource displays the total number of I/O operations per second.
Fields:
n Process Name: Displays the name of the listed process. Clicking a process in the list takes you to
the Component Details page for that process.
n Application Name: Displays the name of the listed application that contains the listed process.
Clicking an application in the list takes you to the Application Details page for that application.
n Network Node: Displays the name of the listed node that contains the listed application and
process. Clicking a node in the list takes you to the Node Details page for that node.
n Total IOPS: Displays the current rate of Input/Output.
Clicking Edit lets you to change the Title, Sub-Title, and Maximum Number of Monitors to Display.
Hovering the mouse over any part of this resource will reveal a tooltip with detailed information about the
item listed.
1125
Server Warranty Summary
This resource displays warranties currently expired and set to expire on the current node. This is done by
SAM periodically checking the status of each server's warranty against Dell, HP, and IBM's online warranty
validation servers.
Click a node in the summary list to display Node Details view for that node.
You can visually see warranties nearing their expiration dates by examining the dates in the Expiration
Date column. Also, if a warranty expiration date crosses a Warning or Critical threshold, progress bars
appear as yellow and red, respectively. Click Edit to customize threshold values as well as filter the
warranties to display.
1126
n Expired Warranties: Lists the nodes that currently have expired warranties.
n Warranties Due to Expire: Lists the nodes that have warranties nearing their expiration date.
n Next 5 Warranties Set to Expire: Lists the top five warranties nearing their expiration date.
Clicking Edit lets you to fine tune the information displayed in this resource.
1127
Application Monitor Thresholds
Thresholds are markers that indicate certain levels have been reached. Many component monitors used in
SAM applications have thresholds that can be adjusted and set.
Once set, thresholds can act as trigger points. For example, if you are monitoring CPU usage, a Critical
threshold set at 90% would be typical. You can use this threshold as a trigger to send an email alert to
inform you of the Critical status once that threshold has been breached.
Normally, an administrator would need to monitor applications for several weeks in order to collect
enough data to be used as a baseline. Once a baseline has been established, the administrator can make
an educated guess how to set Warning and Critical thresholds for the component monitors. Note, if
thresholds are set too low, the administrator would be getting alerts all the time. If set too high, problems
can occur without the administrator's knowledge.
Baseline data, as well as Warning and Critical thresholds for application monitors, can be gathered and
calculated automatically. The option to enter thresholds manually remains available.
1128
Multi-Value scripts and thresholds
The format for using the threshold macros with multi-value scripts is as follows:
n ${Threshold.Warning.DisplayName}
n ${Threshold.Critical.DisplayName}
1129
Understand latest baseline details
The two tabbed charts and table below them detail how baseline statistics and thresholds are calculated
for individual component monitors based on the collected data.
The horizontal (X) axis displays the range of values collected by the current component monitor during the
data collection period. The vertical (Y) axis displays the frequency of each value collected during the data
collection period.
The three colors of the chart show the values of the component monitor during different time periods: Day,
Night, and All Hours. You can show or hide these time periods by checking and un-checking their
respective boxes in the legend.
You can have the chart show a specific time range by dragging the mouse over a small area of the chart.
Hovering over any area of the chart provides a tooltip with detailed information about that area of the
chart.
1130
If you zoom in, a Reset Zoom button appears.
The yellow and red shading of the chart indicates the recommended Warning and Critical thresholds,
respectively. These shaded areas are taken from the values recorded in the Latest Baseline Statistics table.
The ability to check and uncheck the boxes in the legend is for visual purposes only and does not
affect the values generated for calculated thresholds.
The horizontal (X) axis displays the time period for when the values were collected for the current
component monitor. The vertical (Y) axis displays the range of all the values collected during the charted
time.
In other words, the light blue bars show the range of values for the statistics collected during the charted
time period. The bottom of the bars indicates the lowest statistic collected, or the minimum. The top of the
bars indicates the highest statistic collected, or the maximum. The blue line of the chart shows the average
values of the component monitor through time.
Using the legend, you can show or hide these statistics by checking and un-checking their respective
boxes.
You can have the chart show a specific time range by dragging the mouse over a small area of the chart or
by using the sliders located at the bottom of the chart. Hovering over any area of the chart provides a
tooltip with detailed information about that area of the chart.
1131
The yellow and red of the chart indicates the recommended Warning and Critical thresholds, respectively.
These shaded areas are taken from the values recorded in the Latest Baseline Statistics table.
The ability to check and un-check the boxes in the legend is for visual purposes only and does not
affect the values generated for calculated thresholds.
Along with the minimum and maximum values displayed, the Latest Baseline Statistics table at the bottom
of the display shows the average baseline statistics surrounded by three levels of standard deviation for
both day and night data. This table highlights the recommended Warning and Critical thresholds in yellow
and red, respectively.
In addition to using the recommended threshold values, you can hover the mouse over any value in the
table to bring up a tooltip dialog. The tooltip dialog allows you to visualize, but not change, the value for
the Warning or Critical threshold to the value you are hovering over by simply clicking either link in the
dialog. Visualizing a value in this way affects the chart above the table by repositioning the shading
indicating the Warning and Critical threshold areas.
The right column of this view provides information about the data's calculation and usage and allows you
to set thresholds.
1132
In the Current Thresholds Settings area, you can manually change the values for both the Warning and
Critical thresholds, or use the recommended values by clicking Use Recommended Thresholds.
Additionally, you can add logic for these thresholds by selecting an operator from the drop down list such
as Greater Than, Less Than, Equal To, and so on. The logical operator selected applies to both the Warning
and Critical thresholds and cannot be separated. For example, if you select the Greater Than or Equal to
operator with a Warning threshold value of 80 and a Critical threshold of 90, the thresholds are considered
met if the returned value for the current performance counter meets or exceeds 80 for Warning or 90 for
Critical.
1133
Understand sustained thresholds
The highlighted fields in the following illustration are available for configuring sustained thresholds:
The following two tables demonstrate possible sustained threshold conditions based on the illustration
above and how the Warning and Critical conditions are met:
1134
SolarWinds Variables and Examples
Filter syntax reference
Filter syntax reference and navigation
There are two filter syntax types: Structured Query Language (SQL) syntax and SolarWinds Query Language
(SWQL) syntax. The main differences between SQL and SWQL are:
If the resource you are trying to filter creates its list by joining two tables together that contain
properties that share the same name, you cannot filter on that property unless you attach a
particular SQL table name to the beginning of the property name.
SQL or SWQL?
Generally, the resources that have recently been added to SolarWinds Orion use SWQL syntax, the oldest
ones require SQL syntax.
Look for additional guidance at the bottom of the Edit Resource page.
The following screen is displayed where you can enter and execute queries.
1135
SolarWinds SAM SWQL resource matrix
The resource matrix helps you find the SWQL aliases you need to create filter criteria for your resources.
The SWIS entity names are provided so that you know exactly how the SWQL alias maps to the SWIS
entities in your SolarWinds product databases.
Resources for SolarWinds Server & Application Monitor (SAM) use a mix of SWQL and SQL filters. Tables
that start with APM_ are SQL tables and use SQL filters. The remaining are SWIS tables and use SWQL
filtering.
Orion.APM.ApplicationTemplate ApplicationTemplate
All Applications Tree
Orion.APM.CurrentApplicationStatus Status
Orion.Nodes Nodes
Orion.APM.Application Application
Orion.APM.ApplicationTemplate Template
Applications with Problems
Orion.APM.CurrentApplicationStatus Status
Orion.Nodes Nodes
APM_CurrentComponentStatus MonitorStatus
APM_PortEvidence pe
APM_ComponentExt Monitor
APM_Application Application
APM_ThresholdsByComponent thresholdStat
APM_ErrorCode ec
APM_StatusCodeType sct
APM_StatusCode sc
1136
SAM RESOURCE TABLE NAME SWQL ALIAS
APM_CurrentComponentStatus MonitorStatus
APM_PortEvidence pe
APM_CurrentApplicationStatus ApplicationStatus
APM_ThresholdsByComponent Threshold
APM_CurrentComponentStatus MonitorStatus
APM_PortEvidence pe
APM_Application Application
APM_CurrentApplicationStatus ApplicationStatus
APM_CurrentComponentStatus MonitorStatus
APM_PortEvidence pe
APM_CurrentApplicationStatus ApplicationStatus
APM_ThresholdsByComponent Threshold
APM_CurrentComponentStatus MonitorStatus
APM_PortEvidence pe
APM_CurrentApplicationStatus ApplicationStatus
APM_ThresholdsByComponent Threshold
1137
SolarWinds EOC SWQL resource matrix
All SolarWinds Enterprise Operations Console (EOC) resources use SWQL filtering.
Alert Resources
EOC.Node Node
Global Last XX Active Alerts
EOC.Node.CustomProperty Node.CustomProperty
EOC.Orion SWServer
EOC.Alert2 Alert
EOC.Orion SWServer
Event Resources
EOC.Orion SWServer
EOC.Event Event
EOC.EventType EventType
EOC.Orion SWServer
EOC.EventName EventName
Groups Resources
1138
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.Groups Groups
EOC.StatusInfo StatusInfo
EOC.Groups Groups
Global Groups With Problems
EOC.Orion SWServer
Inventory Resources
EOC.Node Node
Number of Nodes by Device Type
EOC.Orion SWServer
EOC.Node Node
Number of Nodes by IOS/OS
EOC.Orion SWServer
EOC.Interface I
Global Top XX Error & Discards
EOC.Node N
Today
EOC.Orion SWServer
EOC.Interface I
Global Top XX Interfaces by
EOC.Node N
Percent Utilization
EOC.Orion SWServer
1139
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.Interface I
Global Top XX Interfaces by
EOC.Node N
Relative Multicast Packet Rate
EOC.Orion SWServer
EOC.Interface I
Global Top XX Interfaces by
EOC.Node N
Traffic
EOC.Orion SWServer
EOC.Node Node
Global Top XX Nodes by CPU Load
EOC.Orion SWServer
EOC.Node N
EOC.Volume.Stats VS
1140
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.NCM.Nodes NCMNode
Global Configuration
EOC.Node Node
Manager Nodes
EOC.Orion SWServer
EOC.NCM.ConfigArchive ConfigArchive
EOC.Orion SWServer
EOC.NCM.CacheDiffResults CacheDiffResults
EOC.NCM.ComparisonCache ComparisonCache
Global Last XX Config
EOC.NCM.Nodes NCMNode
Changes
EOC.Node Node
EOC.Orion SWServer
EOC.NCM.LatestPolicyReportViolations LPR
Global Policy Violations
For Each SolarWinds EOC.NCM.PolicyReports PR
Server
EOC.Orion O
1141
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.Interface I
EOC.Interface I1
EOC.NetFlow.Source S
EOC.Node N
EOC.Node N1
EOC.Orion SWServer
EOC.NetFlow.Engine S
NetFlow Collector Services
EOC.Orion SWServer
EOC.APM.ApplicationTemplate AT
EOC.APM.CurrentApplicationStatus CAS
Global All Applications
EOC.Node N
EOC.Node.CustomProperty NodeCustomProperty
EOC.Orion SWServer
EOC.APM.Application Application
EOC.Orion SWServer
1142
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.APM.Application A
EOC.APM.ApplicationTemplate AT
Global Applications by
EOC.APM.CurrentApplicationStatus CAS
Status EOC.Node N
EOC.Node.CustomProperty NodeCustomProperty
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.ApplicationTemplate AT
Global Applications with
EOC.APM.CurrentApplicationStatus CAS
High Process CPU Load
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.CurrentApplicationStatus CAS
Global Applications with
EOC.APM.CurrentStatistic CS
High Process Memory Used
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.CurrentApplicationStatus CAS
Global Applications with
EOC.APM.CurrentStatistic CS
High Response Time
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.ApplicationTemplate AT
Global Applications with
EOC.APM.CurrentApplicationStatus CAS
Issues
EOC.Node N
EOC.Orion SWServer
1143
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.APM.Application A
EOC.APM.Component Monitor
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.CurrentComponentStatus CCS
Global Top XX Process
EOC.APM.CurrentStatistic CS
Monitors by CPU Load
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.CurrentComponentStatus CCS
Global Top XX Process
Monitors by Physical EOC.APM.CurrentStatistic CS
Memory
EOC.Node N
EOC.Orion SWServer
EOC.APM.Application A
EOC.APM.CurrentComponentStatus CCS
Global Top XX Process
Monitors by Virtual EOC.APM.CurrentStatistic CS
Memory
EOC.Node N
EOC.Orion SWServer
1144
RESOURCE SWIS ENTITY NAME SWQL ALIAS
Top XX Nodes by Percent Ports
EOC.Node N
Used
EOC.Orion SWServer
EOC.UDT.NodeCapability S
EOC.UDT.NodeStatistics NS
EOC.AlertStatus AlertStatus
Global Active IP SLA
EOC.IpSla.Operation IpSlaOperation
Operation Alerts
EOC.IpSla.OperationType IpSlaOperationType
EOC.Orion SWServer
EOC.AlertStatus AlertStatus
EOC.AlertDefinition AlertDefinition
EOC.IpSla.Operation IpSlaOperation
EOC.IpSla.OperationStatus ipSlaOperationStatus
EOC.IpSla.Site SourceSite
EOC.IpSla.Site TargetSite
EOC.Node Node
EOC.Orion SWServer
EOC.Event Event
EOC.Orion SWServer
1145
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.IpSla.Operation IpSlaOperation
EOC.IpSla.OperationCurrentStat IpSlaOperationCurrentStat
EOC.IpSla.OperationStatus ipSlaOperationStatus
EOC.IpSla.OperationType IpSlaOperationType
EOC.IpSla.Site TargetSite
EOC.Node SourceNode
EOC.Node TargetNode
EOC.Orion SWServer
EOC.Node N1
EOC.Node N2
EOC.Orion SWServer
Global Top XX Call Paths by
EOC.Voip.Link L
Jitter
EOC.Voip.Site S1
EOC.Voip.Site S2
EOC.Voip.UdpResultDetail D
EOC.Node N1
EOC.Node N2
EOC.Orion SWServer
Global Top XX Call Paths by
EOC.Voip.Link L
Latency
EOC.Voip.Site S1
EOC.Voip.Site S2
EOC.Voip.UdpResultDetail D
1146
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.Node N1
EOC.Node N2
EOC.Orion SWServer
Global Top XX Call Paths by
EOC.Voip.Link L
MOS
EOC.Voip.Site S1
EOC.Voip.Site S2
EOC.Voip.UdpResultDetail D
EOC.Node N1
EOC.Node N2
EOC.Orion SWServer
Global Top XX Call Paths by
EOC.Voip.Link L
Packet Loss
EOC.Voip.Site S1
EOC.Voip.Site S2
EOC.Voip.UdpResultDetail D
EOC.Node N1
EOC.Node N2
EOC.Orion SWServer
EOC.Voip.Site S1
EOC.Voip.Site S2
EOC.Voip.UdpResultDetail D
EOC.Node N
EOC.Voip.CCMStatistic C
EOC.Orion SWServer
Global VoIP Collector Services
EOC.Voip.Engine S
1147
RESOURCE SWIS ENTITY NAME SWQL ALIAS
EOC.IpSla.Operation L
EOC.IpSla.OperationCurrentStat D
EOC.IpSla.OperationStatus OperationStatus
Global VoIP Sites Overview
EOC.IpSla.Site S
EOC.Node Node
EOC.Orion SWServer
EOC.SEUM.Transaction T
Global All Transactions
EOC.Orion O
EOC.SEUM.TransactionStep TS
EOC.Orion O
EOC.StatusInfo s
EOC.StatusInfo s2
EOC.SEUM.TransactionStep TS
Global Top XX Steps by Duration
EOC.Orion O
EOC.SEUM.Transaction T
Global Transaction Health
EOC.Orion O
Overview
EOC.StatusInfo S
EOC.SEUM.Transaction T
Global Transactions With
EOC.Orion O
Problems
EOC.StatusInfo S
1148
Summary Report Resources
EOC.Orion SWServer
EOC.Node Node
Global Down Nodes
EOC.Orion SWServer
EOC.Node Node
EOC.Orion SWServer
EOC.Node Node
Global Nodes with High CPU Load
EOC.Orion SWServer
EOC.Node Node
Global Top XX Nodes with
EOC.Node.CustomProperty NodeCustomProperty
Problems
EOC.Orion SWServer
EOC.Node N
Global Volumes with High Percent
EOC.Orion SWServer
usage
EOC.Volume V
1149
SysLog Resources
EOC.Orion SWServer
SysLog Messages from All
EOC.SysLog SysLog
Network Devices
EOC.SysLogFacility SysLogFacility
EOC.SysLogSeverity SysLogSeverity
EOC.Orion SWServer
Syslog Summary
EOC.SysLog SysLog
Trap Resources
EOC.Node Node
EOC.Orion SWServer
Traps from All Network Devices
EOC.Trap Trap
EOC.TrapVarbind TrapVarBind
Wireless Resources
EOC.Wireless.Interface WI
EOC.Node N
Top XX Access Points by Number
EOC.Orion SWServer
of Clients
EOC.Wireless.Interface WI
EOC.Node N
Top XX Wireless Clients by Traffic
EOC.Orion SWServer
Rate
EOC.Wireless.Client WC
1150
SWQL filter syntax examples
The following sections detail how to filter in SWQL by using the most frequently requested examples.
Wildcards
n Interface
n Node
n Volume
Use the SWQL alias for these data types when selecting custom properties for your queries. The property
syntax to filter by custom property is:
alias.CustomProperties.propertyName
Example filter to only show nodes with the custom property City that matches Atlanta:
NodesCustomProperties.CustomProperties.City = 'Atlanta'
Use the SWQL alias when selecting properties for your queries.
Examples
NodesData.Vendor = 'Cisco'
Example filter to show data from Process Monitor – SNMP type component monitors:
Monitor.ComponentType = 8
Filtering by status
To filter by the status property, you must know the valid status levels.
LEVEL STATUS
0 Unknown
1151
LEVEL STATUS
1 Up
2 Down
3 Warning
14 Critical
MonitorStatus.Availability<>2
1152
SQL Filter Syntax Examples
The following sections detail how to filter in SQL by using the most frequently requested examples.
Wildcards
dataType.CustomProperty.propertyName
Example filter to only show nodes with the custom property City that matches Atlanta:
NodesCustomProperties.CustomProperty.City = 'Atlanta'
Examples
Vendor = 'Cisco'
Example filter to show data only from component monitors named Server Load Monitor:
Filtering by Status
To filter by the status property, you must know the valid status levels.
LEVEL STATUS
0 Unknown
1 Up
2 Down
3 Warning
14 Critical
MonitorStatus.Availability<>2
1153
Variable Modifiers
Variables can be modified by using any of the variable modifiers in the following table.
VARIABLE
MODIFIER DESCRIPTION
-Raw Displays the raw value for the statistic. For example, if Transmit Bandwidth is set to 10
Mbps, then the raw value would be“10000000”. The cooked value would be “10 Mbps”.
-Previous Displays the previous value for the statistic before the Alert was triggered
-Cooked Displays the cooked value for the statistic. For example, if Transmit Bandwidth is set to
10 Mbps, then the raw value would be “10000000” and cooked value would be “10
Mbps”.
- Displays the previous cooked value for the statistic before the Alert was triggered
PreviousCooked
${N=context;M=Modifier(macroName)}
${N=Alerting;M=Previous(AcknowledgedBy)}
Date and time of the last event for this Alert. (Windows control panel defined
${AlertTriggerTime}
“Short Date” and “Short Time”).
1154
Date Time
The following are valid date and time variables.
${N=Generic; M=DateTime; Current date and time. (Windows control panel defined “Long Date”
F=DateTime} and “Long Time” format)
1155
DATE/TIME VARIABLE DESCRIPTION
Group Variables
The following are valid group variables.
1156
Group Variable Description
${N=OrionGroup; Name of group member status. For more information see Status
M=GroupMemberStatusName} Variables.
${N=OrionGroup; 100% when group status is Up, Warning, Critical and 0% if status
M=GroupPercentAvailability} is anything else.
${N=OrionGroup; M=GroupStatusID} Identifier assigned to a group indicating its status. For more
information see Status Variables.
${N=OrionGroup; M=GroupStatus} Name of group status. For more information see Status
Variables.
SQL Query
Any value you can collect from the database can be generated, formatted, or calculated using a SQL query
as a variable. To use a SQL query as a variable in Orion Platform products, use ${SQL:{query}} as shown
in the following example that returns the results of the SQL query:
1157
Note: SolarWinds does not support SQL queries directly. Visit our user forums on thwack for help from our
community.
Status Variables
When using the ${Status} variable with a monitored object, status values are returned, as appropriate.
The following table provides a description for each status value.
0 Unknown
1 Up
2 Down
3 Warning
4 Shutdown
5 Testing
6 Dormant
7 Not Present
9 Unmanaged
10 Unplugged
11 External
12 Unreachable
14 Critical
15 Mixed Availability
16 Misconfigured
19 Unconfirmed
22 Active
24 Inactive
25 Expired
1158
STATUS VALUE DESCRIPTION
26 Monitoring Disabled
27 Disabled
28 Not Licensed
Important: As of Orion Platform version 2015.1, SolarWinds alerts use a new variable format. See General
Alert Variables for more information.
Node variables
The following are valid node variables.
1159
Node Variable Description
1160
Node Variable Description
1161
Node Variable Description
${N=SwisEntity;M=SNMPv3Credentials.
SNMPv3 read/write credential key
RWPrivacyKey}
${N=SwisEntity;M=SNMPv3Credentials.
SNMPv3 authentication key
AuthenticationKey}
1162
Node Variable Description
AuthenticationMethod}
${N=SwisEntity;M=SNMPv3Credentials.
SNMPv3 credential key
PrivacyKey}
${N=SwisEntity;M=SNMPv3Credentials.
SNMPv3 credential key type
PrivacyMethod}
${N=SwisEntity;M=SNMPv3Credentials.
User friendly name for SNMPv3 credential
Username}
1163
Node Variable Description
${VolumeAllocationFailuresThisHour} Number of volume allocation errors for this volume in last hour.
1164
View monitored objects on maps
Maps in the Orion Web Console can show monitored nodes, interfaces and volumes, SAM applications and
components, and network links.
Network Maps
Create customized maps in Network Atlas, including wireless heat maps, and display them in the
Orion Web Console.
In the Network Atlas, you can also create wireless heat maps to visualize the signal strength
provided by your wireless access points.
1165
The Worldwide Map
The Worldwide Map resource represents nodes and groups of nodes on a realistic geographical map that
can be displayed on Orion Web Console views. When a map is viewed in the console, you can zoom in and
out, view concise information pop-ups for nodes and groups, and access Node detail pages by double
clicking an object.
Only one Worldwide map can be created, but can be included in as many views as required.
However, the Worldwide Map in each view can have its own title, and you can apply filters to show a
different selection of objects.
You can add nodes and groups of nodes to the Worldwide map automatically or manually. If you decide to
add objects automatically, GPS co-ordinates and street address information, held within each node's
Custom Properties, is used to determine each object's location. Objects that do not have this information
can be added manually.
If you try to drag an automatically placed object to another location on the map, a warning
message is displayed to inform you that the object will be treated as a manually placed object
once it is moved.
If the icon in not displayed in exactly the right place, you can drag-and-drop it into the correct
location, or click Edit Location and amend the Latitude and Longitude coordinates.
1166
Map objects
1167
Network Atlas Maps
Orion Network Atlas is a powerful tool for creating custom maps and network diagrams. The maps created
in Orion Network Atlas enable users to view a graphical depiction of their network in the Orion Web
Console. You can also use the maps to create network documentation, which can then be printed and
exported as needed.
Map objects may include monitored NPM nodes, interfaces, and volumes; SAM applications and
components; nested maps; and network links. The numerous presentation options for your network maps
include the following:
l A large set of predefined background colors, textures, and images is available for you to use in your
maps. You can also provide your own custom background graphics.
l Real-time weather or natural disaster maps may be projected directly onto your network maps using
linked web graphics as a background.
l The shape, size, color, and style of map links may be customized to illustrate the status or the
relative bandwidth of associated objects.
l Map objects may be presented in a unique set of graphical styles to portray network status.
l Maps may be nested to selectively reveal increasing levels of map detail, and the status of nested
map child objects may be bubbled up to the parent map.
Orion Network Atlas is also fully compatible with all network maps created with Orion Map Maker used
with earlier versions of Orion products. For more information, see the SolarWinds Orion Network Atlas
Administrator Guide.
For information on adding Network maps to your Console views, see Display a Network Atlas map in the
Orion Web Console.
1168
Understand the Credentials Library
You typically need to associate credentials with component monitors to enable them to retrieve application
data. For example, to use a WMI monitor, you must provide valid domain or computer credentials. Or, if
your web server requires credentials, you must provide the appropriate credentials to access the
protected sections of your site.
n Adding credentials to the Credentials Library for use later. See the section Adding Credentials to the
Credentials Library.
n Creating credentials on the spot (Quick Credentials) when editing templates and component
monitors. See the section Using Quick Credentials.
n Editing credentials. See the section Editing Credentials in the Credentials Library.
n Deleting credentials. See the section Deleting Credentials from the Credentials Library.
n db_owner
n db_accessadmin
n db_securityadmin
n db_ddladmin
n db_datareader
n db_datawriter
n db_backupoperator
Notes:
1169
n SolarWinds Server & Application Monitor uses the same SNMP credentials that you entered during
node discovery. There is no need to specify additional credentials for SNMP operations.
n SolarWinds SAM stores credentials encrypted in the database.
n The ability to Inherit Windows credentials from node is available in the drop down list.
1170
Add, edit, and delete credentials within the Credentials Library
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Credentials
Library > Add New Credential.
2. Provide a name for the credential set. SolarWinds Server & Application Monitor
displays this name in the Credential for Monitoring field of monitors that
accept credentials.
3. Provide the user name and password, and then confirm the password and click
Submit. If you are providing windows credentials for accessing and harvesting
information through WMI, ensure you provide the account name in the
following syntax: domainOrComputerName\user name for domain level
authentication or User Name for workgroup level authentication.
You may need to log in with an administrator account to perform this action.
1. From the Credentials Library, click Edit for the desired credential.
2. Modify the information as needed and then click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Credentials
Library.
2. Click Delete for the desired credential.
3. Click OK to confirm the deletion.
1171
Use Quick Credentials
1. If the credential you want to assign does not exist, create it by following these
instructions:
a. Select <New Credential> in the Choose Credential field.
b. Type a name for the new credential in the Credential Name field.
c. Type the user name for the credential in the User Name field.
d. Type the password in the Password field, and type it again in the
Confirm Password field.
2. To assign an existing credential, select the credential from the Choose
Credential field.
3. Click Set Component Credentials to set this credential as the credential for all
the components in the Application Monitor or template.
1172
Component Monitor Types
The available component monitors are as follows:
1173
n SSL Certificate Expiration Date monitor
n SMTP monitor
n SNMP monitor
n SOAP component monitor
n SQL Server User Experience monitor
n TACACS+ User Experience monitor
n TCP Port monitor
n Tomcat Server monitor
n VMware Performance Counter monitor
n Web Link monitor
n Windows Event Log monitor
n Windows PowerShell monitor
n Windows Script monitor
n Windows Service monitor
n WMI monitor
1174
DHCP User Experience Monitor
This component monitor measures how long it takes to get a lease from a DHCP server. The monitor
verifies that the DHCP responds with an IP address, but neither confirms nor accepts the lease.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
The UDP port used for the DHCP request. The default value is 67.
The UDP port used for the DHCP response. The default value is 68.
For SolarWinds servers with multiple network adapters configuration, this field specifies which of the
multiple network adapters is used for the DHCP User Experience monitor. If this setting is not
specified, the default (primary) network adapter is used.
Note: This setting does not affect SolarWinds servers with only one network adapter.
Unicast - This is the default DHCP Discovery Request Type. The broadcast flag is not set, the
ciaddr (Client IP Address) is set to the local address, and the giaddr (Relay Agent IP Address) is
not set. The DHCP client sends a unicast DHCP DISCOVER to the DHCP server IP address and
the UDP Request Port (defaults to 67). The DHCP server then sends a unicast DHCP Offer to the
ciaddr address and the UDP Response Port (defaults to 68).
This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM
server or on a different subnet.
1175
Broadcast - The broadcast flag is set, the ciaddr (Client IP Address) is set to the local address,
and the giaddr (Relay Agent IP Address) is not set. The DHCP client sends a unicast DHCP
DISCOVER to the DHCP server IP address and the UDP Request Port (defaults to 67). The DHCP
server then sends a broadcast DHCP Offer to the UDP Response Port (defaults to 68).
This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM
server
Relay Agent - The broadcast flag is not set, the ciaddr (Client IP Address) is set to the local
address, and the giaddr (Relay Agent IP Address) is set to the local address. The DHCP client
sends a unicast DHCP DISCOVER to the DHCP server IP address and the UDP Request Port
(defaults to 67). The DHCP server then sends a unicast DHCP Offer to the giaddr (Relay Agent IP
Address) and the UDP Request Port (defaults to 67).
This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM
server or on a different subnet.
Note: You can use the Broadcast or Relay Agent DHCP discovery request type to handle the
issue with some DHCP servers (for example Internet Systems Consortium DHCP Server) that do
not send a DHCP Offer back to the SolarWinds SAM Server IP address. They send it to the newly
leased IP address (the IP address being offered) instead. To handle this issue, set the DHCP
Discovery Request Type to either Broadcast or Relay Agent.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1176
Directory Size monitor
This component monitor determines the disk space used by the files in a directory, optionally including all
subdirectories. Files that do not match the File Extensions Filter are not included in the disk space
calculation.
It may be difficult to monitor the size of a folder containing hundreds or thousands of files, because
the monitor timeout duration may lapse before the target computer can finish computing the file
sizes and sending the response.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
The path to the monitored directory. Specify the path in Universal Naming Convention (UNC) format.
For example: \\computername\c$\logfiles\. The path can include the variable ${IP} , which represents
the target node's IP address.
Determines which file extensions are included in the disk space usage calculations for the directory
size. It is a text matching filter, and * is a wildcard.
Include Subdirectories
Determines whether the contents of sub-directories are included in the disk space usage
calculations for the directory size.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
1177
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option. For more information, see Conversion Value.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1178
DNS Monitor - TCP
This component monitor tests a DNS server's ability to respond to a record query and measures its
response time. The record query is an A Name lookup for a.root-servers.net. The component monitor
passes if it receives a valid DNS response (positive or negative).
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
The TCP port used for DNS queries. The default value is 53.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1179
DNS User Experience monitor
This component monitor tests a DNS server's ability to respond to a record query, compares the query
response against a list of IP addresses, and measures the response time. The component monitor passes if
the DNS response matches the expected IP addresses.
The DNS Monitor measures the time it takes the DNS “get" for the record query referenced in the
component monitor to load. This response time is measured in milliseconds.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
The port used for DNS queries. The default value is 53.
Protocol
The fully-qualified domain name (FQDN) or IP address to use for the DNS query. If you specify an IP
address, the query result should be a FQDN. If you specify a FQDN, the query result should be one or
more IP addresses.
The IP addresses or FQDN you expect to result from the DNS query. Type each entry on a new line. If
you do not care about the DNS query result, you can type the asterisk (*) as a wildcard character that
successfully matches any DNS query result.
Specifies that the result of the DNS query must include all expected entries to be considered a
successful test. If this check box is not checked, a single match indicates a successful test.
1180
Response Time Warning Threshold
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}. For more information, see "Configuring SolarWinds SAM Alerts"
1181
DNS Monitor - UDP
This component monitor tests a DNS server's ability to respond to a record query and measures its
response time. The component monitor passes if it receives a valid DNS response (positive or negative)
within the response time threshold. UDP is the primary method of communication for DNS servers.
Statistic
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Port Number
The UDP port used for DNS queries. The default value is 53.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1182
Download Speed monitor
This component monitor measures the time it takes to download data from the target node, and reports
the speed in KB/s (1024 bytes per second). The target node must be running a Character Generator
service.
Statistic
The statistic for this component monitor is the download speed in KB/s (1024 bytes per
second).
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
The port used for the character generator service. The default value is 19.
The amount of data in kilobytes (kb) you want to download from the node for testing the download
speed.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
1183
Statistic Warning Threshold
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1184
Exchange Web Services User Experience monitor
This component monitor simulates an email round trip to test the ability of your SMTP server to receive
and distribute email, and the ability of your users to retrieve email through Exchange Web Services.
Credentials: Credentials used for this monitor should be the user for whom the mailbox will be
monitored.
If you receive a server error while browsing Exchange Web Services, refer to the following Microsoft
KB article located at: http://support.microsoft.com/kb/2020789
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state, not influencing SolarWinds SAM application availability or status.
If the credential you need is not already present in the credentials list, use the Quick Credentials
section to add a new credential.
This credential must be the email address of the account which is to be simulated and
not the credentials of the Windows computer. (Name, ovacha (@), domain). For example:
Username@domain.com. (Credentials used for this monitor should be the user for
whom the mailbox will be monitored.)
Enter the email address where you want an email to be sent from
Send Email To
This field allows you to specify the URL of your Exchange Web Server.
Ignore CA Errors
Ignore CN Errors
1185
SMTP Server
SMTP Port
If needed, select the proper credentials from the drop down list.
SMTP Encryption
Select the conditions from the drop down lists for the Warning and Critical thresholds, then set the
time, in seconds, for these conditions to be met.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1186
File Age Monitor
This component monitor determines when a file was last modified. The statistic is the number of elapsed
hours since the file modification date.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
File Path
This field is the path to the monitored file, including the file name. Specify the path in Universal
Naming Convention (UNC) format. For example: \\computername\c$\logfile\errors.log.
The path can include the variable ${IP} which represents the target node's IP address.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
1187
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1188
File Count monitor
This component monitor counts the number of files in a directory, optionally including its subdirectories.
Files that do not match the file extension or file attribute type are ignored.
This monitor may fail if you attempt to count more than 20,000 files in a directory using the wildcard *
filter extension. To get an accurate count of the files in such large directories, you must instead create a
Windows Script monitor that runs the File Count script located in the script examples folder C:\Program
Files\SolarWinds\Orion\APM\SampleScriptMonitors\WindowsScripts.
Statistic
The number of files in the directory that match the file extensions filter.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
This field is the path to the directory. Specify the path in Universal Naming Convention (UNC) format.
For example: \\computername\c$\. The path can include the variable ${IP} which represents the
target node's IP address. There is a limit of 260 characters for this field.
Specifies which files to include in the count based on the file extension. You can specify multiple file
extensions separated by commas or spaces. To include all files, specify *.
Specifies which files to include in the count based on the file attributes. The default value is All Files.
1189
Include Subdirectories
Specifies the file count should also include files located inside subdirectories
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1190
File Existence monitor
This component monitor tests if a file exists at the given file path and uses ports TCP/445 and UDP/445 .
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
File Path
This field is the path to the monitored file, including the file name. Specify the path in Universal
Naming Convention (UNC) format. For example: \\computername\c$\logfile\errors.log. The path can
include the variable ${IP} which represents the target node's IP address.
This field specifies whether the component monitor should test for whether the file must exist file or
must not exist.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1191
File Change monitor
This component monitor tests if a file has been modified and then reports the time in hours since the file
was modified as a statistic. The component monitor performs an MD5 checksum comparison on the file to
verify it was not modified. If SolarWinds SAM detects the monitored file was modified, the component
monitor will remain in a Down state until you recalculate the checksum.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
File Path
This field is the path to the monitored file, including the file name. Specify the path in Universal
Naming Convention (UNC) format. For example: \\computername\c$\logfile\errors.log. The path can
include the variable ${IP} which represents the target node's IP address.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field is the calculated checksum against which SolarWinds SAM is comparing the monitored file.
To calculate a new checksum, click Update Checksum.
1192
Select and upload a file for snapshot creation
This field is the local path to a file on the user's computer (where the web browser is running) used
to calculate the checksum against which the monitored file is compared. Click Browse to open a
Windows Choose File dialog from which you can select the file directly. Click Update Checksum to
calculate the new checksum.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1193
File Size monitor
This component monitor measures the size of a file at the given file path and then reports the file size in
bytes as a statistic.
Statistic
The statistic for the component monitor is the file size in bytes.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has read access to the file. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
File Path
This field is the path to the monitored file, including the file name. Specify the path in Universal
Naming Convention (UNC) format. For example: \\computername\c$\logfile\errors.log. The path can
include the variable ${IP} which represents the target node's IP address.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
1194
Statistic Critical Threshold
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1195
FTP User Experience monitor
This component monitor tests the ability of an FTP server to accept an incoming session, process the user
login, and then transmit the specified file to the SolarWinds SAM server. After receiving the file,
SolarWinds SAM performs a file integrity test comparing the SHA1 checksum of the downloaded file
against a previously generated checksum. If the checksums match, the component monitor reports its
status as Up.
The FTP Monitor measures the time it takes the FTP “get” for the reference in the component monitor to
load. This response time is measured in milliseconds.
Configure the FTP User Experience Monitor and generate a snapshot checksum
You must use the Update Checksum command to create a new snapshot checksum each time you
update or modify the test.txt file on the FTP server.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
1196
Credential for Monitoring
Select a credential that can log on to the FTP server. For example, to monitor an anonymous FTP
server, select or add a credential containing anonymous as the user name and your email address
as the password. If the credential you need is not already present in the credentials list, use the
Quick Credentials section to add a new credential.
Port Number
This field is the port number used for FTP sessions. The default value is 21.
Url
Allows you to specify the URL of the file you want to monitor. The URL can include the variable ${IP}
which represents the target node's IP address, and the variable ${PORT} which represents the value
in the Port Number field.
Use Proxy
This check box allows you to use a web proxy to access the web site.
Proxy Address
This field allows you to specify the address of a web proxy to access the web site.
Passive Mode
This check box allows you to monitor the file using passive mode FTP. This mode is typically used to
circumvent a firewall that would otherwise filter the incoming connection to the SolarWinds SAM
server.
This field is the calculated checksum against which SolarWinds SAM is comparing the monitored file.
To calculate a new checksum, click Update Checksum.
This field is the local path to a file on the SolarWinds SAM server that is used to calculate the
checksum against which the monitored file is compared. Click Browse to open a Windows Choose
File dialog from which you can select the file directly. Click Update Checksum to calculate the new
checksum.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
1197
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1198
FTP monitor
This component monitor tests the ability of an FTP server to accept incoming sessions and respond with
the correct codes.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the port number used for FTP sessions. The default value is 21.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1199
HTTP Form Login monitor
This component monitor tests the ability of a web server to serve web pages secured behind a forms-
based login page. The test is performed by using the credential as the user name and password for the
login form, retrieving the page behind the login form, and then searching the retrieved page for keywords
that indicate either a successful or a failed login attempt.
The HTTP Form Login Monitor does not work on any login screens that are pop up.
Statistic
Troubleshooting
For most form-based login pages, this component monitor functions without any
customizations. But, some form-based login pages use unconventional HTML form tag names
or form input tag names, and you need to assist the component monitor in identifying the
names of these tags before the component monitor can function correctly.
This monitor does not work if the login control is located within an IFRAME HTML
control.
If the component monitor cannot match the tag names in the login page against the list of
expected keywords, you must add the actual tag name to the keywords list. SolarWinds SAM
assists you with this by displaying an error status message if the component monitor is in a fail
state: the error message lists all the form and form input names found in the HTML page,
allowing you to identify the correct name so that you can type it in the appropriate Keywords
field.
For example, consider the following HTML snippet with tags defining a form and some form
inputs:
In the example code, the actual login input tag name is "nick,” but testing the component
monitor results in an error similar to the following:
The error status message informs you that the component monitor incorrectly assumed the
input tag with the name "status" was the login input. Recognizing this error, you correct it by
adding the correct tag name "nick" to the list of keywords in the Login Control Keywords field:
1200
(login)|(name)|(email)|(nick)
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that can log on to the web site. If the credential you need is not already present in
the credentials list, use the Quick Credentials section to add a new credential.
Port Number
This field is the port number used for HTTP forms-based login sessions. The default value is 80.
Url
Allows you to specify the URL you want to monitor. The SolarWinds SAM variable ${IP} contained in
the default value for this field attempts to monitor a web site at the IP address of the assigned node.
Host Header
Use Proxy
This check box allows you to use a web proxy to access the web site.
Proxy Address
This field allows you to specify the address of a web proxy to access the web site.
Ignore CA Errors
If checked, this indicates that Certificate Authorization (CA) errors will be ignored.
Ignore CN Errors
If checked, this indicates that Common Name (CN) errors will be ignored.
Accept Compression
1201
Login Form Keywords
This field lists the expected keywords that identify an HTML login form. The keywords are matched
against the name attribute of the <form> tags found in the HTML of the login page. Each keyword in
this list must be enclosed in parentheses '( )', and then separated from other keywords by a vertical
bar '|'. The default keywords are: (login)|(auth)|(email).
This field lists the expected keywords that identify the form's user name input element. The
keywords are matched against the name attribute of the <input> tags found in the HTML of the login
page. Each keyword in this list must be enclosed in parentheses '( )', and then separated from other
keywords by a vertical bar '|'. The default keywords are (login)|(name)|(email).
This field lists the expected keywords that identify the form's password input element. The keywords
are matched against the name attribute of the <input> tags found in the HTML of the login page.
Each keyword in this list must be enclosed in parentheses '( )', and then separated from other
keywords by a vertical bar '|'. The default keywords are (password)|(pwd)|(passwd)|(psswd)|(pswd).
This field contains the regular expression for matching an unsuccessful login. This expression may
appear anywhere in the HTML source of the page.
This field contains the regular expression for matching a successful login. This expression may
appear anywhere in the HTML source of the page.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1202
HTTP monitor
This component monitor tests a web server's ability to accept incoming sessions and transmit the
requested page. The component monitor can optionally search the delivered page for specific text strings
and pass or fail the test based on that search.
The HTTP Monitor measures the time it takes the HTTP “get” for the page referenced in the component
monitor to load. This response time is measured in milliseconds.
If a web page redirects to another page, the response time measures the entire time from the
original request until the last redirected page is loaded.
n ${Node.SysName}
n ${Node.Caption}
n ${Node.DNS}
n ${Node.ID}
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
If the web site is password-protected, select a credential that can access the web site. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential.
Port Number
The port used for the web site. The default value is 80.
1203
Url
This field allows you to specify the URL you want to monitor. The SolarWinds SAM variables
contained in the default value for this field attempt to monitor a web site at the IP address of the
assigned node ${IP} and on the port specified in the Port Number field ${PORT} .
Proxy Servers: To prevent proxy servers from caching the monitored URL, you can append a unique
query string to the URL with the ${TimeStamp} variable.
Host Header
Host Request
Content Type:
Request Body:
{
"firstname": "Kate"
"lastname": "Asaff"
"age" : 29
"city" : "Austin"
}
Follow Redirect
This allows you to specify the component monitor to automatically follow server-side redirects.
Use Proxy
This check box allows you to use a web proxy to access the web site.
Proxy Address
This field allows you to specify the address of a web proxy to access the web site.
1204
User Agent
This field allows you to emulate a specific user agent or browser type when contacting the web site.
For example, to emulate Internet Explorer version 7, type Mozilla/4.0 (compatible; MSIE 7.0b;
Windows NT 6.0). For more information about user agent strings, see
http://www.useragentstring.com
Search String
This field contains the text string indicating successful page retrieval. If the specified string is found
in the web page content, the monitor is considered up.
Note: The search string is not case-sensitive.
Fail if Found
This check box allows you to reverse the default behavior of the search string. If the search string is
found in the web page content, the monitor is considered down instead of up.
Head Request
This field allows you to ensure the web site responds to the HTTP protocol, but without checking the
validity of the web page content. Search strings are ignored if you select this option.
Accept Compression
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1205
HTTPS monitor
This component monitor tests a web server's ability to accept incoming sessions over a secure channel and
then transmit the requested page. The component monitor can also test the security certificate.
The HTTPS Monitor measures the time it takes the HTTPS “get” for the page referenced in the component
monitor to load. This response time is measured in milliseconds.
If a web page redirects to another page, the response time measures the entire time from the
original request until the last redirected page is loaded.
n ${Node.SysName}
n ${Node.Caption}
n ${Node.DNS}
n ${Node.ID}
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
If the web site is password-protected, select a credential that can access the web site. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential.
Port Number
The port used by the web site. The default value is 443.
1206
Url
This field allows you to specify the URL you want to monitor. The SolarWinds SAM variables
contained in the default value for this field attempt to monitor a web site at the IP address of the
assigned node ${IP} and on the port specified in the Port Number field ${PORT} .
Proxy Servers: To prevent proxy servers from caching the monitored URL, you can append a unique
query string to the URL with the ${TimeStamp} variable.
Host Header
Host Request
Content Type:
Request Body:
{
"firstname": "Kate"
"lastname": "Asaff"
"age" : 29
"city" : "Austin"
}
Follow Redirect
This allows you to specify the component monitor to automatically follow server-side redirects.
Use Proxy
This check box allows you to use a web proxy to access the web site.
Proxy Address
This field allows you to specify the address of a web proxy to access the web site.
Certificate Subject
This is used for selecting a private key when client authentication is used.
1207
This field allows you to specify the X.509 certificate subject (DN). Use spaces ( ) or commas (,) to
separate the different subject fields. Semicolons, commas with spaces after them, and newline or
carriage returns are not acceptable separators.
It allows you to select a certificate from Current User > Personal certificate store using its
subject. The subject must equal the exact format to find the certificate using .NET.
For example: To find a specific certificate, you need to use the following format:
Ignore CA Errors
This check box allows you to specify the component monitor to ignore the certificate authority (CA).
Ignore CN Errors
This check box allows you to specify the component monitor to ignore the certificate name (CN).
User Agent
This field allows you to emulate a specific user agent or browser type when contacting the web site.
For example, to emulate Internet Explorer version 7, type Mozilla/4.0 (compatible; MSIE 7.0b;
Windows NT 6.0). For more information about user agent strings, see
http://www.useragentstring.com
Search String
This field contains the text string indicating successful page retrieval. If the specified string is found
in the web page content, the monitor is considered up.
Note: The search string is not case-sensitive.
Fail if Found
This check box allows you to reverse the default behavior of the search string. If the search string is
found in the web page content, the monitor is considered down instead of up.
Head Request
This check box allows you to ensure the web site responds to the HTTPS protocol, but without
checking the validity of the web page content. Search strings are ignored if you select this option.
Accept Compression
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
1208
Response Time Critical Threshold
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1209
IMAP4 monitor
This component monitor tests the ability of an IMAP4 server to accept incoming connections and respond
with the correct code.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the port number used for IMAP4 sessions. The default value is 143.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1210
IMAP4 User Experience monitor
This component monitor tests an email round trip from your SMTP mail server to your IMAP4 server and
measures the time it takes to complete the trip. This response time is measured in milliseconds.
This component monitor uses the following ports when used with a Microsoft Exchange mail server:
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that can retrieve email from an IMAP4 server. If the credential you need is not
already present in the credentials list, use the Quick Credentials section to add a new credential.
Credentials used for this monitor should be the user for whom the mailbox will be monitored.
This field allows you to specify the From address of the test email message.
Send Email To
This field allows you to specify the recipient of the test email message. The recipient should have a
mailbox on the IMAP4 server you are monitoring.
IMAP4 Port
This field is the port number used for IMAP 4 sessions. The default value is 143. For Secure IMAP
(IMAP4-SSL), use port 585. For IMAP4 over SSL (IMAPS), use port 993.
IMAP4 Encryption
This list allows you to select an encryption protocol to connect to IMAP4 servers that support SSL or
TLS encryption.
1211
SMTP Server
This field allows you to specify the SMTP server that sends the test email message.
SMTP Port
This field is the port number used for SMTP sessions. The default value is 25.
This check box allows you to use the user name and password from Credentials for Monitoring to
connect to SMTP servers that support or require authentication.
SMTP Encryption
This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or
TLS encryption.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1212
JMX monitor
This template tests the overall performance of a Java Application Server
Prerequisites: The JMX connector must be enabled on the Java application server.
Credentials: You may need either JMX credentials or none at all. This depends on the credentials
required based on the configuration of your Java application server.
Polling via the JMX Component Monitor is not supported using an agent.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
This allows you to set JMX credentials for querying MBeans. If the credential you need is not already
present in the credentials list, use the Quick Credentials section to add a new credential.
Port Number
This field allows you to specify the port number used for JMX connections.
Protocol
This field allows you to choose between using Remote Method Invocation (RMI) and Invocation over
Internet Inter-Orb Protocol (IIOP). Note: RMI should be correctly referred to as RMI/JRMP and IIOP as
RMI/IIOP based on JMX Specifications.
URL Path
This field is for the last part of the JMX service URL. This follows hostname:portnumber and
begins with a slash. For example:
service:jmx:rmi:///jndi/rmi://HostName:portnumber/jmxrmi
Object Name
This field is for the unique string identifier of an MBean in the form of <domain-name>:<key
property>.
1213
Attribute Name
Key
This is used for monitoring composite attributes, which consist of key:value pairs. Note: SAM
only supports monitoring of numerical data type attributes.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1214
LDAP User Experience Monitor
This component monitor tests the capabilities of a Lightweight Directory Access Protocol (LDAP) server, and
measures the time it takes to perform an LDAP query.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has administrator access to the LDAP server. If the credential you need is not
already present in the credentials list, use the Quick Credentials section to add a new credential.
Port Number
The port used for LDAP connections. The default value is 389. For LDAP over SSL, use port 636.
Encryption Method
Specifies an encryption method for the LDAP connection. The default setting is None.
Authentication Method
Specifies the authentication method for the LDAP connection. The default setting is Simple.
LDAP Filter
Specifies the search parameters of the LDAP query. The default LDAP Filter value is (&
(objectClass=Person)(cn=someuser)), and it searches for all entries that have objectClass=Person and
cn=someuser.
1215
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1216
Linux/Unix Script monitor
This component monitor uses SSH to upload a script to a Linux/Unix server, runs the script on the server,
and then processes the return value and text output.
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they will simply be ignored.
Statistic
The statistic for this component monitor is the Statistic value returned by the script.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Authentication Type
Choose either User name and Password or User name and Private Key. The second option allows you
to use certificates for authentication.
Select a credential that can access the Linux or Unix server over SSH, and that has sufficient rights to
run scripts. If the credential you need is not already present in the credentials list, use the Quick
Credentials section to add a new credential.
Port Number
This field allows you to specify the port number used for the SSH connection. The default value for
this field is 22.
This field allows you to specify the working directory of the script process.
Changes the statistic to be the difference in query values between polling cycles.
1217
Command Line
This field allows you to specify the shell command run after the SSH connection is established. The
default command line value perl ${SCRIPT} arg1 arg2 attempts to run in a Perl interpreter the script
defined in the Script Body field using the parameters arg1 arg2.
Note: The length of the Command Line field is limited to 266 characters for Solaris systems,
minus the length of the ${SCRIPT} variable after being resolved to a file name such as the
following: APM_937467589.pl. Since the length of the file name will typically be around 16
characters, this means that the actual user Command Line input cannot be longer than 266 –
16, or about 250 characters (not including the length of the 9 characters for the “${SCRIPT} ”
variable itself).
If you need to pass a longer command line to the target node, you can create a shell script on
the target node (for example myscript.sh) that contains the long command line, and place the
call to this script in the Command Line field, for example: /opt/sw/myscript.sh
Script Body
This field allows you to specify the script you want to run on the Linux or Unix server.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1218
MAPI User Experience monitor
This component monitor sends an email from your SMTP mail server to your Microsoft Exchange Server
Mailbox and measures the time it takes to complete the trip. You can use this component monitor to
monitor the performance of Outlook. This response time is measured in milliseconds.
The Exchange Server computer uses port 135 for client connections to the RPC endpoint mapper service.
After a client connects to a socket, the Exchange Server computer allocates the client two random ports to
use to communicate with the directory and the information store.
For a complete list of network ports used by Microsoft Server Products, refer to the following article:
http://technet.microsoft.com/en-us/library/cc875824.aspx
This component monitor requires you to install the Microsoft Exchange Server MAPI Client and
Collaboration Data Objects on your SolarWinds SAM server. You can download the MAPI Client from: The
Microsoft Download Center. http://www.microsoft.com/downloads/details.aspx?FamilyID=E17E7F31-079A-
43A9-BFF2-0A110307611E
Statistic
This component monitor does not compute a statistic. The response time is the difference
between the time SolarWinds SAM sends the email and the time it is received by the recipient.
Notes:
1. This component monitor waits for the email to arrive based on the default job timeout of 20 minutes.
If the email does not arrive within this period, SolarWinds SAM marks the monitor as down.
2. The monitor goes through the following steps with respect to the mail flow:
a. Sends an email to the user mailbox via SMTP. The email has a unique temporary subject
name that starts with APM_prefix.
b. Connects to the user mailbox through MAPI, then searches the emails by Subject.
c. If it does not find the email it is looking for, it waits and then searches again. It stops when: it
finds the email, the timeout is reached, or the maximum number of attempts is reached.
d. Once it finds the email, the monitor deletes it from the user inbox.
e. The monitor collects the total round trip time for the email and compares it with the
thresholds set.
f. Once it knows the round trip time, status is given according to where it falls with regard to
the thresholds set.
If the email is not found within the timeout or the maximum number of attempts, or SMTP or
MAPI reported an error, SolarWinds SAM marks the monitor as Down.
3. Emails the monitor sends are deleted from user inboxes, but only if the monitor successfully
connected via MAPI. If the SMTP call succeeded, but MAPI failed, the email remains in the user inbox.
4. It is not currently possible to use the monitor without SMTP and send the email from the same
server the monitor is running on via MAPI.
1219
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that is both a user who can log on to the SolarWinds SAM server, and that has an
Exchange account on the MAPI server. If the credential you need is not already present in the
credentials list, use the Quick Credentials section to add a new credential. Credentials used for this
monitor should be the user for whom the mailbox will be monitored.
This field allows you to specify the From address of the test email message.
Send Email To
This field allows you to specify the recipient of the test email message. The recipient should have a
mailbox on the MAPI server you are monitoring.
SMTP Server
This field allows you to specify the SMTP server that sends the test email message.
SMTP Port
This field is the port number used for SMTP sessions. The default value is 25.
This check box allows you to use the user name and password from Credentials for Monitoring to
connect to SMTP servers that support or require authentication.
SMTP Encryption
This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or
TLS encryption.
1220
Response Time Warning Threshold
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1221
Nagios Script monitor
This component uses SSH to upload a Nagios script to a Linux/Unix server, runs the Nagios script on the
server and then processes the script's exit code and text output. This monitor has the ability to return
multiple values.
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they are ignored.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
Select a Windows credential that is both a user who can log on to the SolarWinds SAM server, and
has sufficient rights on the target node to do whatever the script needs to do. For example, if the
script does something with WMI, the credentials also need WMI rights on the target node. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential.
Port Number
This field allows you to specify the port number used for the SSH connection. The default value is 22.
This field allows you to specify the working directory of the script process.
Check Type
0 OK Up
1 Warning Up or Down/Unreachable†
1222
2 Critical Down/Unreachable
3 Unknown Down/Unreachable
_______________________
† If the Use Aggressive Host Checking option is enabled, return codes of 1 result in a host state
Changes the statistic to be the difference in query values between polling cycles.
Command Line
This field is in the script editing window and allows you to specify the script you want to run on the
target node followed by the arguments. To enter your script, click the Edit button that reveals the
script editing window. For more information, see http://nagios.sourceforge.net/docs/3_
0/pluginapi.html.
Body
This field is in the script editing window and allows you to enter your script via typing or pasting.
Status Roll-Up
This option allows you to choose how you would like the monitor to report based on the output
provided by the script. The default selection is “Show worst status.”
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1223
NNTP monitor
This component monitor tests the ability of an NNTP server to accept incoming connections and respond
with the correct code.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the port number used for NNTP connections. The default value is 119.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1224
ODBC User Experience monitor
This component monitor uses synthetic transactions to test the abilities of an ODBC-accessible database
such as MySQL. The component monitor connects to the database, performs a query, and then retrieves
the data. ODBC drivers for your database type must be installed on the SolarWinds SAM server.
The SQL statement you use for this query must return a numerical value, not a varchar.
This monitor has the ability to capture message text in the first row, second column of SQL query
results. This string value is shown in the Messages field of the component monitor.
Statistic
The statistic for this component monitor is the first row and column of the data retrieved by
the query. It must be a numerical value.
You must install on the SolarWinds SAM server the ODBC drivers for your database. For more
information on acquiring or installing the ODBC drivers, consult your database documentation.
Note: In some situations, monitors derived from this ODBC component can fail because the bit
mode setting (x32/x64) is set incorrectly. This can happen to database servers that only install
x64 drivers on a x64, making this monitor inaccessible in x32 mode.
TCP Ports
This component monitor uses port TCP/1630. Oracle Connection Manager provides the
listening port for Oracle client connections to Oracle Connection Manager. You can configure
Oracle Connection Manager either through a custom installation, or configure it after
installation using Net Configuration Assistant.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a database credential that can access the database. If the credential you need is not already
present in the credentials list, use the Quick Credentials section to add a new credential.
1225
Connection String
This field allows you to specify the ODBC connection string for the database. If you do not know the
connection string to your ODBC-accessible database, you can look it up on
http://www.connectionstrings.com. The connection string may include the variables ${IP}, ${USER},
and ${PASSWORD}, which are replaced respectively by the IP address of the database server, the
credential user name, and the credential password.
If you are using the ODBC User Experience Monitor instead of the SQL Server User Experience
monitor for a SQL Server database that is not using the default port 1433, perform the following to
create a connection string.
For additional information about creating and configuring Universal Data Link (.udl) Files, refer to
the MSDN article.
Sql Query
This field allows you to specify the SQL query used to test the database. The retrieved data is then
used as the component monitor statistic. You may enter up to 4,000 characters.
Query Timeout
The amount of time, in seconds, until the SQL query will timeout.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
1226
Response Time Warning Threshold
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1227
Oracle User Experience monitor
This component monitor uses synthetic transactions to test the abilities of an Oracle database. The
component monitor connects to the database, performs a query, and then retrieves the data. Oracle Net
Services from the Oracle Client must be installed on the SolarWinds SAM server.
The SQL statement you use for this query must return a numerical value, not a varchar.
This monitor has the ability to capture message text in the first row, second column of SQL query
results. This string value is shown in the Messages field of the component monitor.
Statistic
The statistic for this component monitor is the first row and column of the data retrieved by
the query. It must be a numerical value.
This component monitor requires you to install the Oracle Net Services from the Oracle Client
on your SolarWinds SAM server. You can download the Oracle Client from:
TCP Ports
This component monitor uses ports TCP/1521 and TCP/1526. The Oracle SQL*Net Listener
allows Oracle client connections to the database over Oracle's SQL*Net protocol. You can
configure it during installation. To reconfigure this port, use Net Configuration Assistant.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
1228
Credential for Monitoring
Select a database credential that can access the database. If the credential you need is not already
present in the credentials list, use the Quick Credentials section to add a new credential.
Port Number
This field allows you to specify the port number used to communicate with the Oracle database. The
default value for this field is 1521.
SQL Query
This field allows you to specify the SQL query used to test the database. The retrieved data is then
used as the component monitor statistic. You may enter up to 4000 characters.
This option tells SolarWinds SAM whether you are accessing the database by its Oracle System ID
(SID) or by its service name.
SID:
Service_Name:
Select this to access the database by its service name. Though we call this option 'net service
name', do not enter the net service name.
This field allows you to specify either the service name or the SID to access the Oracle database over
a network. Do not enter the net service name. To determine the name or SID of the database, refer to
the tnsnames.ora Oracle configuration file or ask your database administrator.
1229
ORA11DATABASE) ))
Allows you to select the driver from the drop down list.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
Scenario:
The steps below should result in a successfully tested and monitored database.
1230
1. The first item to install is the Oracle Instant Client Basic. (In this scenario, we also install
the Instant Client ODBC and SQLPlus packages).
2. Create the directory where the products will be stored. (i.e.: c:\Oracle)
3. Unzip the files into the created directory and preserve the path. ( i.e.: Instantclient_11_2).
4. Modify your path to reference the directory that the Instant Client files were extracted to:
5. Log out to ensure Windows identifies the variables you defined.
6. Create a TNSNAMES.ora file and save it in to c:\oracle\instantclient_11_2. (Note: An
example of TNSNAMES.ora can be found at: http://www.orafaq.com/wiki/Tnsnames.ora)
7. Install the SolarWinds Oracle Plug-in
n Each application item was set up using a SERVICE_NAME point type, with the database name as the
Destination Port Name.
n The User ID to be used for this test cannot be limited or restricted, otherwise it will return errors.
n Test each component monitor.
1231
Performance Counter monitor
This component monitor reads Windows Performance Counter data using Remote Procedure Calls (RPC)
instead of Windows Management Instrumentation (WMI). All performance counters are assumed to exist
within the root/CIMV2 namespace.
TCP/135; RPC/named pipes (NP) TCP 139, RPC/NP TCP 445, RPC/NP UDP 137, RPC/NP UDP 138
Statistic
The statistic for this component monitor is the performance counter value.
Optionally, the statistic may be set as the difference in query values between polling cycles by
checking the option for Count statistic as difference.
Note: The Count Statistic as Difference option is applicable only for monitors whose counter
value increases consistently during each polling interval. Examples of when this option is not
applicable include cases such as the following:
n Counter values sometimes increase and sometimes decrease from one polling interval to
another (typical behavior for many counters)
n Counter values consistently decrease from one polling interval to another
n In these cases where the option is not applicable, negative statistic data values are
replaced with zero (0), and the counter monitor shows 0 as the statistic data value in
resources and 0 as the value on statistic data charts for this interval.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Component Type
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a Windows credential that has RPC access to the target node. This is typically a Windows
administrator-level credential.
This option changes the statistic to be the difference in counter values between polling cycles.
1232
Counter
Instance
Enter the instance name of the performance counter. For example: _Total.
If the performance counter has multiple instances, you can monitor each instance separately by
creating a Performance Counter Monitor for each instance. For example, the performance counter
% Processor Time has two instances if you have a dual-CPU system: 0 for the first CPU and 1 for the
second CPU. You can create a separate Performance Counter Monitor to monitor each instance of the
counter.
Category
Enter the category of the performance counter. All performance counters are assumed to exist
within the root/CIMV2 namespace. For example: Processor.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1233
POP3 monitor
This component monitor tests the ability of a POP3 server to accept incoming connections and respond
with the correct code.
This component monitor uses the following ports when used with a Microsoft Exchange mail server:
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the port number used for POP3 connections. The default value is 110. For Secure POP3
(SSL-POP) use port 995.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
1234
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1235
POP3 User Experience Monitor
This component monitor tests an email round trip from your SMTP mail server to your POP3 mail server
and measures the time it takes to complete the trip. This response time is measured in milliseconds.
Statistic
Field Descriptions:
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that has sufficient access rights to retrieve email from the POP3 server. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential. Credentials used for this monitor should be the user for whom the mailbox
is monitored.
This field allows you to specify the From address of the test email message.
Send Email To
This field allows you to specify the recipient of the test email message. The recipient should have a
mailbox on the POP3 server you are monitoring.
POP3 Port
This field is the port number used for POP3 sessions. The default value is 110. For Secure POP3 (SSL-
POP) use port 995.
POP3 Encryption
This list allows you to select an encryption protocol to connect to POP3 servers that support SSL or
TLS encryption.
SMTP Server
This field allows you to specify the SMTP server that sends the test email message.
1236
SMTP Port
This field is the port number used for SMTP sessions. The default value is 25.
This check box allows you to use the user name and password from Credentials for Monitoring to
connect to SMTP servers that support or require authentication.
SMTP Encryption
This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or
TLS encryption.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1237
Process monitor - SNMP
This component monitor uses SNMP communication to test if a specified process is running, and reports
the CPU and physical memory used by all instances of the process.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
This optional field allows you to select which instances of a process you want to monitor, based on
the command line arguments of the process. This is a text match, and partial matches are also valid.
Process Name
This field allows you to specify the process name you want to monitor. If you do not know the process
name, SolarWinds SAM can help you find processes to monitor.
CPU Threshold
These fields allow you to set warning and critical threshold conditions based on the percentage of
CPU resources in use by the monitored process.
These fields allow you to set warning and critical threshold conditions based on the amount of
physical memory in use by the monitored process.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1238
Process monitor - WMI
This component monitor uses WMI or RPC communication to test if a specified Windows process is
running, and reports the CPU, virtual memory, and physical memory used by all instances of the process.
The WMI Process Monitor retrieves two samples (after 5 seconds) from the Win32_PerfRawData_PerfProc_
Process class (PercentProcessorTime and TimeStamp_Sys100NS properties). It then calculates the CPU
usage from these two samples.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a Windows credential that has WMI rights on the target node. This is typically a Windows
administrator-level credential. If the credential you need is not already present in the credentials
list, use the Quick Credentials section to add a new credential.
Fetching Method
This optional field allows you to select which instances of a process you want to monitor, based on
the command line arguments of the process. This is a text match and partial matches are also valid.
1239
Process Name
This field allows you to specify the process name you want to monitor. If you do not know the process
name, SolarWinds SAM can help you find processes to monitor using the Component Monitor Wizard
wizard.
CPU Threshold
These fields allow you to set warning and critical threshold conditions based on the percentage of
CPU resources in use by the monitored process.
These fields allow you to set warning and critical threshold conditions based on the amount of
physical memory in use by the monitored process.
These fields allow you to set warning and critical threshold conditions based on the amount of
virtual memory in use by the monitored process.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1240
RADIUS User Experience monitor
This component monitor uses synthetic transactions to test user authentication through the RADIUS
protocol. The synthetic transaction does the following:
This component monitor will not work using an agent as the polling method.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
This field is the RADIUS protocol authentication port. The default value is 1812. Cisco devices may
require port 1645.
This field is the RADIUS protocol accounting port. The default value is 1813. Cisco devices may
require port 1646.
Secret Key
These fields allow you to set warning and critical threshold conditions based on the response time.
The response time is the time in milliseconds it takes SolarWinds SAM to determine that a
component is not Down and to retrieve any statistical data.
1241
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1242
Service Status – SNMP
This component monitor tests and reports the status of a service using SNMP. Service statuses are:
1. Running
2. Continue Pending
3. Pause Pending
4. Paused
Statistic
The statistic for this component monitor is the value for one of the reported statuses: 1-4.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
This field is the Display name of the service to monitor. You can find the Display name on Windows
systems by clicking Start > Administrative Tools > Services and then locating the desired service. The
Display name for the service is the value in the Name column.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1243
SMTP monitor
This component monitor tests the ability of an SMTP server to accept incoming connections and respond
with the correct code.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the port number used for SMTP connections. The default value is 25. For Secure SMTP
(SSMTP), use port 465.
This field allows you to set the Warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1244
SNMP monitor
This component monitor uses the SNMP protocol to retrieve an entry in a Management Information Base
(MIB) by its Object Identifier (OID), and returns the value of the entry as a statistic.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Component Type
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Method Type
Get - A manager-to-agent request to retrieve the value of a variable or list of variables. Desired
variables are specified in variable bindings (values are not used). Retrieval of the specified variable
values is to be done as an atomic operation by the agent. A Response with current values is
returned.
Get Next - A manager-to-agent request to discover available variables and their values. Returns a
Response with variable binding for the lexicographically next variable in the MIB. The entire MIB of
an agent can be walked by iterative application of GetNextRequest starting at OID 0. Rows of a table
can be read by specifying column OIDs in the variable bindings of the request.
Specify the OID of the entry in the MIB you want to retrieve.
This field is the port number of the custom SNMP port. Set this field to 0 to use the default SNMP
port defined in the Node’s properties.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
1245
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1246
SOAP component monitor
SOAP is a communication system that delivers and receives messages and instructions.
Currently, the SOAP monitor within SAM can only detect the presence of a string and return a status
of either Up or Down.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
SOAP XML Request
You can either choose to load XML from a WSDL file or manually enter the XML. If you choose to
manually enter the SOAP XML request, you must populate the following fields:
n Web Service Server URL: The http(s) address of web server. For example:
https://localhost:17778/SolarWinds/v3/OrionBasic
n SOAP Action: Indicates the intent of the SOAP HTTP request. For example:
http://schemas.solarwinds.com/2007/08/informationservice/QueryXml
n SOAP Version: Select either 1.1 or 1.2 from the drop down list.
n SOAP XML: This is the XML envelope.
Loading the SOAP XML from a WSDL displays the following fields once the WSDL is
successfully loaded:
n Web Service Server URL:The http(s) address of web server. For example:
https://localhost:17778/SolarWinds/v3/OrionBasic
n Binding: Displays the type of binding detected in the WSDL.
n Service Name: Displays the service name detected in the WSDL.
n Method Name: Displays the method name detected in the WSDL.
1247
n Query: This is a dynamically generated field for Simple and Complex method
parameters where you can input values that you can include as part of the SOAP
message. (May not be present depending upon the type of argument used.)
n Parameters: This is a dynamically generated field for Simple and Complex method
parameters where you can input values that you can include as part of the SOAP
message. (May not be present depending upon the type of argument used.)
n Method Name Space: The unique identifier for the method. This definitional
information is extracted from the WSDL file.
n Schema Name Space: The unique identifier for the schema. This definitional
information is extracted from the WSDL file.
n SOAP Action: The unique name for the method itself. This definitional information is
extracted from the WSDL file.
n SOAP Version: Displays the SOAP version detected in the WSDL. This definitional
information is extracted from the WSDL file.
n SOAP XML: Content for this field is dynamically generated by changing the other SOAP
settings. This field serves for reviewing the envelope. Advanced users can edit the
content in this field.
HTTP User Agent
This identifies the client that is making the request. For example, Google Chrome identifies
itself as “Mozilla/5.0 (Windows NT 6.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/32.0.1667.0 Safari/537.36” Some web services may behave differently based on the
user agent.
HTTP Content Type
Indicates the format of the content of the message. With SOAP, this can either be
application/soap+xml or text/xml.
Accept Compression
Indicates to the server whether or not the client supports compression of the data.
Certificate Subject
Ignore CA Errors
Decide whether or not to ignore any errors verifying the Certificate Authority. This can occur if
the certificate is self-signed or if the certificate was not installed correctly on the server.
Ignore CN Errors
Ignore Common Name error. This occurs when the Common Name of the certificate does not
1248
match the name of the server that is in the URL.
Use Proxy
This option allows you to tell the monitor whether or not it is going through a proxy connection.
Proxy Address
Search String
Fail if Found
Select either Yes or No to determine if this monitor reports a status of Fail if the string is found.
Select and enter appropriate thresholds for Warning and Critical statuses.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1249
SQL Server User Experience monitor
This component monitor uses synthetic transactions to test the abilities of a Microsoft SQL Server
database. The component monitor connects to the database, performs a query, and then retrieves the
data.
The SQL statement you use for this query must return a numerical value, not a varchar.
This monitor has the ability to capture message text in the first row, second column of SQL query results. This string value
is shown in the Messages field of the component monitor.
Statistic
The statistic for this component monitor is the first row and column of the data retrieved by
the query. It must be a numerical value.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
Select the Default Port or a Static Port from the drop down menu. If a static port is chosen, only
values between 1 and 65535 are acceptable. Typically, port 1433 is used for this monitor.
Select a Windows credential or SQL Server credential that can access the database. If the credential
you need is not already present in the credentials list, use the Quick Credentials section to add a
new credential.
Sql Query
This field allows you to specify the SQL query used to test the database. The retrieved data is then
used as the component monitor statistic. You may enter up to 4000 characters.
This field allows you to specify the SQL Server instance required to access the SQL Server database.
Enter only the instance name. Do not prefix the instance name with the server name. To access the
default instance, leave this field blank.
1250
Initial Catalog
This field allows you to specify the initial database (catalog) for the connection.
Select this check box to access a SQL Server that supports or requires Windows Authentication, and
specifies that the credential is a Windows credential instead of a SQL Server credential.
Query Timeout
Allows you to specify when this query should timeout in seconds. The default timeout period is 30
seconds.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1251
SSL Certificate Expiration Date monitor
This component monitor tests a web server's ability to accept incoming sessions over a secure channel and
then test the security certificate's expiration date.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
1252
Statistic Critical Threshold
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1253
TACACS+ User Experience monitor
This component monitor uses synthetic transactions to test user authentication through the TACACS+
protocol. The synthetic transaction does the following:
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the TACACS+ protocol connection port. The default value is 49.
Secret Key
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
1254
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1255
TCP Port monitor
This component monitor tests the ability of a TCP/IP-based service to accept incoming sessions. The
Monitor tries to establish a socket connection using the Connect method of System.Net.Sockets.TcpClient
class in the .NET framework. The elapsed time for a connection is saved as Response Time in the result.
More information can be found at http://msdn.microsoft.com/en-us/library/8s2yca91.aspx).
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which is automatically saved. The variable to access
this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Port Number
This field is the TCP protocol connection port. The default value is 80.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1256
Tomcat Server monitor
This component monitor collects server resource information from Apache Tomcat servers by retrieving
status information from http://{$IP}:{$PORT}/manager/status/?XML=true.
Statistic
One of the following Tomcat variables as specified in the Tomcat Variables Name field.
Free Memory
Total Memory
Total memory currently allocated to the Java Virtual Machine heap space.
Max Memory
Maximum size of the heap space not including the permanent generation area.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
1257
Credential for Monitoring
Select a credential that can access the password-protected portion of the web site. If the credential
you need is not already present in the credentials list, use the Quick Credentials section to add a
new credential.
Port Number
This field allows you to specify the port number used by the web site. The default value for this field
is 8080.
Url
Allows you to specify the URL you want to monitor. The SolarWinds SAM variables ${IP} and ${PORT}
contained in the default value for this field attempts to monitor a web site at the IP address of the
assigned node.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
1258
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1259
VMware Performance Counter monitor
The VMware Performance Counter monitor reads VMware performance counter data using the VMware
vSphere Web Services API.
The currently used vSphere Web Services API version is 4.0, which supports vSphere 4.0 servers and also is
compatible with previous releases of ESX/ESXi and VirtualCenter Server, including the following:
Statistic
The statistic for this component monitor is the value of the performance counter data retrieved
by the VMware API.
Optionally, the statistic may be set as the difference in retrieved values between polling cycles
by checking the option for Count statistic as difference.
Note: The Count statistic as difference option is applicable only for monitors whose counter
value increases consistently during each polling interval. Examples of when this option is not
applicable include cases such as the following:
n Counter values sometimes increase and sometimes decrease from one polling interval to
another (typical behavior for many counters)
n Counter values consistently decrease from one polling interval to another
In these cases where the option is not applicable, negative statistic data values will be
replaced with zero (0), and the counter monitor will show 0 as the statistic data value in
resources and 0 as the value on statistic data charts for this interval.
Field Description
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Component Type
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
1260
Credential for Monitoring
Select a VMware credential that can access the VMware API. This is typically a vCenter/ESX Server
administrator-level credential. If the credential you need is not already present in the credentials
list, use the Quick Credentials section to add a new credential.
Note: Read-Only credentials are sufficient since VMware objects are accessed solely in read-only
mode.
Port Number
Url
Changes the statistic to be the difference in query values between polling cycles.
Entity Type
(Only applicable if you are monitoring VirtualCenter Server) – Data object that
aggregates the computation resources of its associated Host System objects into
one single computation resource for use by virtual machines. The cluster services
such as HA (High Availability), DRS (Distributed Resource Scheduling), and EVC
(Enhanced vMotion Compatibility), enhance the usefulness of this single
computation resource. This Entity Type is specific to vCenter systems.
Host System – Managed object type that provides access to a virtualization host platform.
l Resource Pool – Represents a set of physical resources which may be a single host, a subset of a
host's resources, or resources spanning multiple hosts. You can subdivide Resource pools by
creating child resource pools. In order to run, a virtual machine must be associated as a child of a
resource pool. In a parent/child hierarchy of resource pools and virtual machines, the root resource
pool is the single resource pool that has no parent pool.
l Virtual Machine – Managed object type for manipulating virtual machines, including templates that
can be repeatedly deployed as new virtual machines. This object type provides methods for
configuring and controlling a virtual machine.
Entity Name
Specifies the VMware entity name to monitor, for example VirtualMachine1. For VMs, you can view
these values using the VMware console.
1261
This field may contain the special ${VMWARE_ENTITY_NAME} variable. When the monitor runs, this
variable will be resolved to the first available entity on a target host with the desired Entity Type (for
example, the first Host System).
Group
Specifies the VMware group to which the counter belongs, for example: CPU, memory, and so forth.
Counter
Specifies the VMware counter to fetch, for example: coreUtilization, and so forth.
Note: Click Component Monitor Wizard on the SAM Settings page to browse the counters available
for monitoring, including their groups, rollup types, and instance names. Then select one of the
following component monitor types, depending on what you want to monitor:
n VMware ESX Performance Counter Monitor – monitors performance counters for ESX
servers
n VMware vCenter Performance Counter Monitor – monitors performance counters for
vCenter servers
Rollup Type
Specifies the way to roll up the VMware counter data, for example: average, latest, summation, and
so forth.
Instance
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1262
Web Link monitor
This component monitor collects the number of broken or invalid links on a web page.
Prerequisites: None
Credentials: None
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a credential that can access the password-protected portion of the web site. If the credential
you need is not already present in the credentials list, use the Quick Credentials section to add a
new credential.
Url
Allows you to specify the URL you want to monitor. The SolarWinds SAM variable ${IP} contained in
the default value for this field attempts to monitor a web site at the IP address of the assigned node.
Accept Compression
Exclusion Filter
Allows you to create an exclusion filter if there are links the component monitor should not attempt
to validate. It is a text matching filter.
This option excludes external links from validation. External links are links that do not link back to
the same second-level domain as the original URL.
1263
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to set the warning threshold conditions based on the response time. The
response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is
not Down and to retrieve any statistical data.
This field allows you to set critical threshold conditions based on the response time. The response
time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down
and to retrieve any statistical data.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1264
Windows Event Log monitor
This component monitor can use both WMI and RPC communication to scan Windows Event Logs for recent
events matching your defined criteria. Events are considered recent based on the age of the event as
compared to the application polling frequency. If a matching event is found, the component monitor
changes status.
The component monitor eventually returns to its original status as time passes so you may not notice a
matching event unless you create an alert to email you when the component goes down.
n TCP/135; RPC/named pipes (NP) TCP 139, RPC/NP TCP 445, RPC/NP UDP 137, RPC/NP UDP 138
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a Windows credential that has access to the Windows event logs on the target node. This is
typically a Windows administrator-level credential. If the credential you need is not already present
in the credentials list, use the Quick Credentials section to add a new credential.
Fetching Method
Log to Monitor
Select Any Log to match events found in any log or select a specific log to restrict your search. If the
log you want is not listed, select Custom.
Enter the log names as they appear in the Windows event log viewer. Separate multiple log
names with commas. Example: Internet Explorer, SolarWinds.net
1265
Match Definition
Select Any error in log generates a match if that is sufficient for your needs, or select Custom to
further restrict the match criteria.
Log Source
Enter a log source to further restrict the match criteria or leave the field blank to match all
possible log sources.
Event ID
Select the desired option to further restrict the match criteria for event IDs or leave the field
blank to find all possible event IDs:
Event Type
Select Any Event to match any event type in the log, or select a specific event type to further
restrict the match criteria.
Enter a user name to further restrict the match criteria. Leave this field blank to match any
users. Enter "N/A" to select only events with no specific user.
Include events
Select With Keywords Below to specify keywords or phrases as the match criteria. Select
Matching Regular Expression Below to specify regular expressions that match text that
appears in the events. For information about the regular expressions syntax, see .”NET
Framework Regular Expressions,” http://msdn.microsoft.com/en-
us/library/hs600312%28VS.80%29.aspx.
Exclude events
Select With Keywords Below to specify keywords or phrases as the match criteria. Select
Matching Regular Expression Below to specify regular expressions that match text that
appears in the events. For information about the regular expressions syntax, see .”NET
Framework Regular Expressions,” http://msdn.microsoft.com/en-
us/library/hs600312%28VS.80%29.aspx.
Enter the number of polling intervals worth of time you want to search the event logs. For
example, to always search the past 20 minutes of event logs, you could set the application
1266
polling interval to five minutes and then set the Number of Past Polling Intervals to four (4 x
5mins = 20mins). Fractional values are valid.
Message and other details of matched events will be available for viewing and alerting when
enabled.
Select whether a found match should set the component status to Up or Down. You can also take
action using the Based on Event Types, or Based on Event Count options.
l Based on Event Types: With this option, the result status of the component monitor will never be
down for a successful poll:
o Critical (When there is at least one event with a severity of Error or FailureAudit.)
o Warning (When there is at least one event with a severity of Warning.)
o Up (When all matched events are either Informational or SuccessAudit.)
l Based on Event Count: With this option, the status of the component monitor will never be down for
a successful poll and the thresholds for the returned value will be applied against the number of
matched events.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1267
Windows PowerShell monitor
This component monitor runs a Windows PowerShell script on the SolarWinds SAM server or a remote
target node and then processes the script's exit code and text output.
The Windows PowerShell Monitor requires Windows PowerShell 2.0. It does not work with Windows
PowerShell 1.0.
If you are having trouble using the Windows PowerShell Monitor, see the following KB article for some
useful tips:
https://support.solarwinds.com/success_center/Server_%26_Application_Monitor_(SAM)/Problems_using_
the_Orion_APM_Windows_PowerShell_Monitor
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they will simply be ignored.
Statistic
The statistic for this component monitor is the Statistic value returned by the script.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a Windows credential that is both a user who can log on to the SolarWinds SAM server, and
has sufficient rights on the target node to do whatever the script needs to do. For example, if the
script does something with WMI, the credentials also need WMI rights on the target node. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential.
The PowerShell monitor handles requests from PowerShell for the credentials to run the script and
resolves them using the selected Credential for Monitoring. However some PowerShell commands
used in scripts require the use of the ${CREDENTIAL} variable. See the note in the Script Body
section below regarding the use of the ${CREDENTIAL} variable.
Execution Mode
This field allows you to specify where to run the PowerShell script:
1268
Count Statistic as Difference
Changes the statistic to be the difference in query values between polling cycles.
Select this option to enable impersonation with the component's credentials. (This works only
in local script execution mode.)
n Local Host can run scripts only locally, that is, on the SolarWinds SAM server. This is the
default value.
n Remote Host can execute scripts remotely (on the selected target node) using the
Windows Remote Management (WRM) system component. WRM should be configured
separately to get it working with the Windows PowerShell monitor.
n If Remote Host is selected, the following options are available:
n Use HTTPS Protocol - if checked, specifies that the secure HTTPS protocol should be
used to send and receive WS-Management protocol requests and responses. Otherwise
the HTTP protocol is used.
n URL Prefix - specifies a URL prefix on which to accept HTTP or HTTPS requests. The
default is wsman.
n Port Number - specifies the TCP port for which this listener is created. For WinRM 1.1
and earlier, the default HTTP port is 80. For WinRM 2.0, the default HTTP port is 5985.
Script Body
This field allows you to specify the PowerShell script you want to run.
Use the ${CREDENTIAL} variable in the script where the credentials are required, as shown in the
following example:
Some PowerShell commands (such as Get-WmiObject as shown in the example above) require the
use of this ${CREDENTIAL} variable. Therefore, the user name from the specified Credential for
Monitoring is stored automatically in the ${CREDENTIAL} variable for you by the monitor. As a result,
the ${CREDENTIAL} variable should not be placed in the Script Arguments field, since it is set
automatically. When the script is run by PowerShell, since no password has been provided, it
prompts for a password and the password from the specified Credential for Monitoring is provided
automatically by the monitor.
Custom Properties can be passed by using the following format: ${Node.Custom.XXX} where xxx
is the name of the custom property.
1269
Script Arguments
This field allows you to specify arguments to pass to the script. You may include the variable ${IP},
which is replaced by the IP address of the target node.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1270
Windows Script monitor
This component monitor runs a Windows script on the SolarWinds SAM server and then processes the
script's exit code and text output. Beginning in version 4.2, this monitor has the ability to return up to ten
pairs, i.e.: 10 statistic values + 10 [optional] messages.
A maximum of 10 output pairs can be returned. If you exceed the maximum allowed, remove the
excess output pairs or they will simply be ignored.
Statistic
The statistic for this component monitor is the value returned by the script.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Component Type
Enable Component
This option determines whether or not the component is enabled. Disabling this component leaves it
in the application as deactivated and does not influence application availability or status.
Select a Windows credential that is both a user who can log on to the SolarWinds SAM server, and
has sufficient rights on the target node to do whatever the script needs to do. For example, if the
script does something with WMI, the credentials also need WMI rights on the target node. If the
credential you need is not already present in the credentials list, use the Quick Credentials section
to add a new credential.
Script Engine
This field allows you to specify the scripting language to be used. The default value is vbscript. Below
is a list of scripting engines that the Windows Script Host supports:
1271
ooRexxScript .rxs Freeware
Changes the statistic to be the difference in query values between polling cycles.
Script
This field allows you to enter the script you want to run on the target node. To enter your script, click
the Edit button that reveals the script editing window.
Script Arguments
This field is in the script editing window and allows you to specify arguments to pass to the script.
You may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced
respectively by the IP address of the target node, the credential user name, and the credential
password.
Body
This field is in the script editing window and allows you to enter your script via typing or pasting.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1272
Windows Service monitor
This component monitor uses WMI or RPC communication to test if a specified Windows service is running,
and reports the CPU, virtual memory, and physical memory used by the service.
Statistic
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
Select a Windows credential that has WMI rights on the target node. This is typically a Windows
administrator-level credential. If the credential you need is not already present in the credentials
list, use the Quick Credentials section to add a new credential.
Fetching Method
SAM will poll the service state, and information about CPU/memory usage will be retrieved
using performance counters.
This field is the Service name of the service to monitor. You can find the Service name on Windows
systems by clicking Start > Administrative Tools > Services and then locating the desired service.
Right-click the service and select Properties from the context menu. The Service name is the value of
the Service name field in the Properties dialog.
CPU Threshold
These fields allow you to set warning and critical threshold conditions based on the percentage of
CPU resources in use by the monitored process.
1273
Physical Memory Threshold
These fields allow you to set warning and critical threshold conditions based on the percentage of
physical memory in use by the monitored process.
These fields allow you to set warning and critical threshold conditions based on the percentage of
virtual memory in use by the monitored process.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1274
WMI monitor
Formerly known as the WMI Performance Counter Monitor, this component monitor uses WMI
communication to obtain the result of a WMI Query Language (WQL) query. The typical result retrieves the
performance data calculated by WMI providers such as the Windows operating system or Microsoft
Exchange Server.
Named instances of SQL Server may have custom class names that do not match the built-in
templates. You must manually change the class name in any WMI Monitor monitoring a named SQL
Server instance. For example, if the named instance is "NAMED,” you must change Win32_
PerfFormattedData_MSSQLSERVER_SQLServerBufferManager to Win32_PerfFormattedData_
MSSQLNAMED_SQLNAMEDServerBufferManager.
Statistic
The statistic for this component monitor is the value of the first row and column of the data
retrieved by the query.
Optionally, the statistic may be set as the difference in query values between polling cycles by
checking the option for Count statistic as difference.
Note: the Count statistic as difference option is applicable only for monitors whose counter
value increases consistently during each polling interval. Examples of when this option is not
applicable include cases such as the following:
n Counter values sometimes increase and sometimes decrease from one polling interval to
another (typical behavior for many counters)
n Counter values consistently decrease from one polling interval to another
In these cases where the option is not applicable, negative statistic data values will be
replaced with zero (0), and the counter monitor will show 0 as the statistic data value in
resources and 0 as the value on statistic data charts for this interval.
Field Descriptions
Description
This field provides a default description of the monitor. You have the ability to override the default
description by adding to or replacing the text, which will then be automatically saved. The variable to
access this field is ${UserDescription}.
Enable Component
Determines whether the component is enabled. Disabling the component leaves it in the application
in a deactivated state not influencing either SolarWinds SAM application availability or status.
1275
Credential for Monitoring
Select a Windows credential that has WMI rights on the target node. This is typically a Windows
administrator-level credential.
WMI Namespace
Specifies the name of the namespace within which all WQL queries are run. The default value is
root\CIMV2.
WQL Query
Type the WQL query you want to run on the target node. This is typically a performance counter
Query, but it can be any WQL query. All WQL queries are run within the root/CIMV2 namespace. The
WQL query for this monitor returns a numeric value. It will not report errors.
Changes the statistic to be the difference in query values between polling cycles.
Convert Value
Checking the Convert Value check box opens the Formula box. From here, you have the ability
to manipulate the returned value with a variety of mathematical possibilities. You can choose
common functions from the drop down lists to manipulate the returned value, or you can
select the Custom Conversion option.
This field allows you to specify when a threshold that indicates a warning level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 15.
This field allows you to specify when a threshold that indicates a critical level has been breached.
Logical operators are in the drop down followed by a blank field for you to enter the value of this
threshold. For example: Less than 5.
User Notes
This field allows you to add notes for easy reference. You can access this field by using the variable,
${UserNotes}.
1276
Worldwide Map of Orion Nodes Resource
1277
Available data transformations
1278
Temperature: CToF({value}) Provides the Fahrenheit result
Celsius to originally presented in Celsius
Fahrenheit
1279
Available data transformations
1280
Regular Expression Pattern Matching
Characters
\xFF where FF Matches the character with the specified \xA9 matches ©
are 2 ASCII/ANSI value, which depends on the code when using the
hexadecimal page used. Can be used in character classes. Latin-1 code
digits page.
1281
Character Classes or Character Sets [abc]
CHARACTER
CLASSES OR
SETS DESCRIPTION EXAMPLE
Any character All characters except the listed special characters. [abc]
except ^,-,],\ matches a,
add that b or c
character to
the possible
matches for
the character
class.
1282
Anchors
CHARACTER
CLASSES OR
SETS DESCRIPTION EXAMPLE
Anchors
^ (caret) Matches at the start of the string to which the regular ^. matches
expression pattern is applied. Matches a position rather a in
than a character. Most regular expression flavors have an abc\ndef.
option to make the caret match after line breaks (i.e. at the Also
start of a line in a file) as well. matches d
in "multi-
line"
mode.
1283
ANCHORS DESCRIPTION EXAMPLE
Quantifiers
? (question Makes the preceding item optional. The optional item is abc?
mark) included in the match, if possible. matches
ab or abc
1284
Quantifiers
*? (lazy Repeats the previous item zero or more times. The .*?
star) engine first attempts to skip the previous item before matches
trying permutations with ever increasing matches of the "def" in
preceding item. abc "def"
"ghi" jkl
+? (lazy Repeats the previous item once or more. The engine .+?
plus) first matches the previous item only once, before trying matches
permutations with ever increasing matches of the "def" in
preceding item. abc "def"
"ghi" jkl
1285
QUANTIFIERS DESCRIPTION EXAMPLE
{n,m} Repeats the previous item between n and m times. Will a{2,4}
where n >= try to repeat m times before reducing the repetition to n matches
1 and m >= times. aa, aaa or
n aaaa
{n,m}? Repeats the previous item between n and m times. Will a{2,4}?
where n >= try to repeat n times before increasing the repetition to matches
1 and m >= m times. aaaa, aaa
n or aa
{n,} where Repeats the previous item at least n times. Will try to a{2,}
n >= 1 match as many items as possible before trying matches
permutations with fewer matches of the preceding item, aaaaa in
up to the point where the preceding item is matched aaaaa
only m times.
{n,}? where Repeats the previous item between n and m times. The a{2,}?
n >= 1 engine first matches the previous item n times before matches
trying permutations with ever increasing matches of the aa in
preceding item. aaaaa
Dot
DOT
CHARACTER DESCRIPTION EXAMPLE
. (dot) Matches any single character except line . matches x or most any
break characters \r and \n. other character
1286
Word Boundaries
Word Boundaries
W ORD
BOUNDARY DESCRIPTION EXAMPLE
Alternation
ALTERNATION
CHARACTER DESCRIPTION EXAMPLE
1287
95th Percentile Calculations
The following example shows how the 95th percentile is calculated for a 10 hour work
day from 8am to 6pm (600 minutes).
1. Over the 10 hours, the following 120 values were collected for inbound traffic
(Mb/s):
0.149 0.623 0.281 0.136 0.024 0.042 0.097 0.185 0.198 0.243 0.274 0.390 0.971
0.633 0.238 0.142 0.119 0.176 0.131 0.127 0.169 0.223 0.291 0.236 0.124 0.072
0.197 0.105 0.138 0.233 0.374 0.290 0.871 0.433 0.248 0.242 0.169 0.116 0.121
0.427 0.249 0.223 0.231 0.336 0.014 0.442 0.197 0.125 0.108 0.244 0.264 0.190
0.471 0.033 0.228 0.942 0.219 0.076 0.331 0.227 0.849 0.323 0.221 0.196 0.223
0.642 0.197 0.385 0.098 0.263 0.174 0.690 0.571 0.233 0.208 0.242 0.139 0.186
0.331 0.124 0.249 0.643 0.481 0.936 0.124 0.742 0.497 0.085 0.398 0.643 0.074
0.590 0.771 0.833 0.438 0.242 0.092 0.376 0.231 0.627 0.249 0.663 0.181 0.636
0.224 0.342 0.697 0.285 0.108 0.211 0.074 0.490 0.271 0.133 0.338 0.242 0.519
0.376 0.331 0.227
2. The values are reordered from high to low.
0.971 0.942 0.936 0.871 0.849 0.833 0.771 0.742 0.697 0.690 0.663 0.643 0.643
0.642 0.636 0.633 0.627 0.623 0.590 0.571 0.519 0.497 0.490 0.481 0.471 0.442
0.438 0.433 0.427 0.398 0.390 0.385 0.376 0.376 0.374 0.342 0.338 0.336 0.331
0.331 0.331 0.323 0.291 0.290 0.285 0.281 0.274 0.271 0.264 0.263 0.249 0.249
0.249 0.248 0.244 0.243 0.242 0.242 0.242 0.242 0.238 0.236 0.233 0.233 0.231
0.231 0.228 0.227 0.227 0.224 0.223 0.223 0.223 0.221 0.219 0.211 0.208 0.198
0.197 0.197 0.197 0.196 0.190 0.186 0.185 0.181 0.176 0.174 0.169 0.169 0.149
0.142 0.139 0.138 0.136 0.133 0.131 0.127 0.125 0.124 0.124 0.124 0.121 0.119
0.116 0.108 0.108 0.105 0.098 0.097 0.092 0.085 0.076 0.074 0.074 0.072 0.042
0.033 0.024 0.014
1288
3. The first 6 values are dropped, as these equal the top 5% of the values.
0.771 0.742 0.697 0.690 0.663 0.643 0.643 0.642 0.636 0.633 0.627 0.623 0.590
0.571 0.519 0.497 0.490 0.481 0.471 0.442 0.438 0.433 0.427 0.398 0.390 0.385
0.376 0.376 0.374 0.342 0.338 0.336 0.331 0.331 0.331 0.323 0.291 0.290 0.285
0.281 0.274 0.271 0.264 0.263 0.249 0.249 0.249 0.248 0.244 0.243 0.242 0.242
0.242 0.242 0.238 0.236 0.233 0.233 0.231 0.231 0.228 0.227 0.227 0.224 0.223
0.223 0.223 0.221 0.219 0.211 0.208 0.198 0.197 0.197 0.197 0.196 0.190 0.186
0.185 0.181 0.176 0.174 0.169 0.169 0.149 0.142 0.139 0.138 0.136 0.133 0.131
0.127 0.125 0.124 0.124 0.124 0.121 0.119 0.116 0.108 0.108 0.105 0.098 0.097
0.092 0.085 0.076 0.074 0.074 0.072 0.042 0.033 0.024 0.014
4. The 95th percentile is 0.771.
1289
Required SolarWinds account permissions
Acces
s Account Folder the account needs to access
Level
NETWORK
read C:\Program Files (x86)\SolarWinds\Orion\
SERVICE
NETWORK
read C:\Windows\Microsoft.NET\Framework\v4.0.30319\Tempora
SERVICE
ry ASP.NET Files
NETWORK
write C:\ProgramData\Application Data\SolarWinds
SERVICE
NETWORK
write C:\InetPub\SolarWinds\web.config
SERVICE
NETWORK
write C:\Windows\TEMP
SERVICE
NETWORK
read C:\Windows\TEMP
SERVICE
Authenticate
write C:\ProgramData\Application Data\SolarWinds\Logs
d Users
1290
Acces
s Account Folder the account needs to access
Level
NETWORK
read C:\
SERVICE
The following table lists account permissions SolarWinds requires to specific cer-
tificates on your server.
Access Level Account Certificate the account needs to access
1291
Notifications in the Orion Web Console
n If you configured the Orion Web Console to check for product updates, an
announcement displays when an update, such as any upgrade, service pack, or
hotfix becomes available.
n If you configured the Orion Web Console to store blog posts, new and unread
posts to the Orion Product Team Blog are announced in the notification bar.
n If you configured a scheduled discovery, results display in the notification bar
when the discovery completes.
n If you are monitoring any VMware ESX or ESXi Servers, the notification bar
displays the number of ESX nodes found during any discovery, and inform you
if any discovered ESX nodes require credentials.
n If you are monitoring Hyper-V nodes, the notification bar informs you when
Hyper-V servers were found during a discovery.
1292
SAM Glossary of Terms
Node - A node is considered to be any endpoint of a given network. For example, any
server or computer on a network is considered a node. Sometimes a node is referred
to as a device.
1293
Template - A template is the blueprint for an application. It is a collection of
component monitors designed to monitor a server or application. You can customize
numerous templates using only the component monitors you need for a specific
environment.
The type of information returned by the component monitor is based upon the type
of monitor being utilized. For example, one type of monitor can report the up or down
status of a service or process, another monitor can return the percentage of free
space of a volume. Another type of component monitor can return up to ten values.
Each monitor type, along with its parameters and returned values and/or states, is
unique.
Each node, along with its applications and component monitors, can be viewed from
the SolarWinds SAM web console as shown in the diagram below. The view can be
customized to suit your needs.
1294
Solutions
If you have problems with a SolarWinds product, the causes are usually related to an incorrect
configuration or corrupted files. The suggestions listed in this section can often clear up these problems.
You can also talk to other users as well as the SolarWinds staff by logging on to thwack.com
As a first step in any troubleshooting procedure, you should back up your Orion database. For more
information, see Creating Database Backups.
SolarWinds runs many components at the same time to deliver a view of your network status. Confirm that
the following components are running on your SolarWinds server:
Services:
n Message Queuing
n Net.Tcp Port Sharing Service
n SNMP Trap Service
n SolarWinds Alerting Engine service
n SolarWinds Collector Data Processor, Management Agent, and Polling Controller services
n SolarWinds Information Service
n SolarWinds Job Engine and Job Engine v2
n SolarWinds Job Scheduler
n SolarWinds Network Performance Monitor Service. All SolarWinds products use this service. It is not
exclusive to SolarWinds SAM.
n SolarWinds Product services
n SolarWinds Information Service
n SolarWinds Module Engine
n SolarWinds Syslog and Trap Services
n SQL Server
n Internet Information Service (IIS)
Many problems disappear when programs are restarted. Stopping and restarting Internet Information
Service (IIS) may eliminate web page problems. Problems with polling or data gathering may be eliminated
by stopping and restarting the SolarWinds Network Performance Monitor Service using the available
shutdown tool that you can locate as follows:
1. Click Start > All Programs > SolarWinds > Advanced Features > Orion Service Manager.
1295
Run the Configuration Wizard
Running the Configuration Wizard, which refreshes files on the web server and performs checks on the
structure of your database, may solve many problems.
Note: Before you run the Configuration Wizard, you should close all open applications and stop the
SolarWinds Network Performance Monitor Service in the Windows Services Control Panel. It is restarted by
the Wizard at the end of its process.
If you are having difficulty acquiring expected values from a selected variable, using the ${VariableName}
format, it may be helpful to include the database table name within the variable name, as in
${Nodes.IP_Address}.
n For more information about moving the SQL Server 2008 temporary directory, tempdb, see “Moving
System Databases - Example A: Moving the tempdb Database.”
If these conditions cannot be met, the WMI component monitors in SAM show an Unknown status.
Examples of some issues that can prevent these conditions from being met include, but are not limited to:
n Trying to connect to a remote computer where you do not have local Administrator rights.
n A firewall blocking the WMI traffic.
n An operating system that is not configured for WMI.
n Mistyping the credential password in the SAM component monitor.
To help diagnose and fix these issues and others, we can test the WMI services, the remote WMI
connections, and the SolarWinds SAM component configuration to discover and correct the issues that can
prevent your WMI component monitors from functioning correctly.
1296
Redefine Windows system temporary directories
Following established Windows standards, the SolarWinds installer may use Windows User and System
TEMP and TMP variable directories as temporary scratch spaces for file expansion and execution. If you do
not have the required scratch space available in the default User or System TEMP and TMP directories, use
the following procedure to redefine your default locations.
Regardless of where you actually install SolarWinds, some common files may be installed where the
operating system of your SolarWinds server are located.
Troubleshooting
If you have problems with an Orion product, the causes are usually related to an incorrect configuration or
corrupted files. The following suggestions can often clear up these problems.
Back up your SolarWinds Orion database using the SQL Server Management Studio. For more information,
search for "back up a database" on the Microsoft TechNet web portal at https://technet.microsoft.com,
and consult the help for the appropriate SQL Server Management Studio version.
l Services:
o Message Queuing
o Net.Tcp Port Sharing Service
o SolarWinds Alerting Engine service
o SolarWinds Collector Data Processor, Management Agent, and Polling Controller services
o SolarWinds Information Service
o SolarWinds Job Engine and Job Engine v2
o SolarWinds Job Scheduler
o SolarWinds Orion Product services
o SolarWinds Orion Information Service
1297
o SolarWinds Orion Module Engine
o SolarWinds Syslog and Trap Services
l SQL Server
l Internet Information Service (IIS)
l SolarWinds Web Console
n To resolve web page problems, stop and restart Internet Information Service (IIS).
n To resolve problems with polling or data gathering, stop and restart Job Engine or Collector services.
1. Navigate to the Orion Service Manager via Start > All Programs > SolarWinds Orion > Advanced
Features.
2. Click Shutdown Everything, and then click Start Everything.
Before you run the Configuration Wizard, you should close all open applications.
To launch the Configuration Wizard, navigate to Configuration Wizard by clicking Start > All Programs >
SolarWinds Orion > Configuration and Auto-Discovery .
This TCP auto-tuning feature is intended as a network-sensitive restriction, applied by the receiver—your
SolarWinds Orion server—on the amount of data it is allowed or able to receive. If any devices along the
network path between your Orion server and your Orion database do not support the TCP window scaling
detailed in RFC 1323, the allowed size of the TCP window in packets sent to your Orion server may not
match the TCP window size reported by packets sent from your Orion server. This mismatch may lead to
failed connections between your Orion server and your Orion database. The following procedure disables
this TCP auto-tuning feature, resetting the TCP receive window to 64kB.
1298
To disable tcp auto-tuning:
Workaround
Add physical memory as a volume for monitoring these servers. When monitored as a volume, the
values will be more in line with your expectations.
1299
3. If you are prompted by User Account Control, click Continue to open the elevated command
prompt.
Note: In some cases, having User Account Control (UAC) enabled on Windows Server 2008 and
Windows Vista (evaluation-only) can lead to installation errors. For more information about disabling
UAC, see the article, “Disabling User Account Control (UAC)” in the SolarWinds Knowledge Base.
4. At the prompt, enter the following: netsh interface tcp set global
autotuninglevel=disabled
5. Close the command prompt window, and then restart your SolarWinds server.
Check your firewall and proxy settings to make sure that your SolarWinds Orion server can connect to the
internet.
1300
WMI troubleshooting flowchart for SolarWinds SAM
The following Microsoft article describes how to set permissions in a workgroup after an upgrade
from Microsoft Windows 2000 Professional to Microsoft Windows XP Professional.
http://support.microsoft.com/?kbid=290403
1301
Test local WMI services
Testing the local WMI services helps isolate any faults on the target server. The testing program is a
Microsoft program named WBEMTest that comes already installed on Microsoft Windows operating
systems.
1. Log on to the target server with an administrator account, then click Start > Run, enter wbemtest.exe
and then click OK.
2. Click Connect on the Windows Management Instrumentation Tester window.
3. Enter root\cimv2 in the field at the top of the dialog box next to the Connect button.
1302
4. Click Connect, then click Enum Classes.
5. Select the Recursive radio button without entering a superclass name, and then click OK.
6. If the list does not appear or does not contain the desired WMI class, WMI is not functioning
correctly.
7. Click Close, and then click Exit.
At times, the WMI performance counters may not get transferred to WMI because services were delayed or
started out of order (http://support.microsoft.com/kb/820847).
Testing the remote WMI connectivity of the target server helps isolate faults that could prevent the target
server from receiving or responding to remote WMI requests. The testing program is a Microsoft program
named WBEMTest that comes already installed on Microsoft Windows operating systems. For more
information, see Remotely test WMI on the target server.
1303
Remotely test WMI on the target server
Complete the following procedure to check whether the target server is responding appropriately to
remote WMI requests that originate from the SolarWinds SAM server.
1. Log on to the SolarWinds SAM server with an administrator account, then click Start > Run, enter
wbemtest.exe and then click OK.
2. Click Connect on the Windows Management Instrumentation Tester window.
3. Enter \\Target_Primary_IP_Address\root\cimv2 in the field at the top of the dialog box.
Replace Target_Primary_IP_Address in the above example with the actual Hostname or Primary IP
Address of the target server.
4. Enter the user name in the User field, the password in the Password field, and
NTLMDOMAIN:NameOfDomain in the Authority field. Replace NameOfDomain with the domain of
the user account specified in the User field.
5. Click Connect, then click Enum Classes.
1304
6. Select the Recursive radio button without entering a superclass name, and then click OK.
7. If the list does not appear, remote WMI is not functioning correctly. Click Close, and then click Exit.
Only a credential that has administrator rights on the target server has the necessary permissions to
access the target server’s WMI services. Make sure that the username and password you are using belongs
to an administrator on the target server.
If the administrator credential is a domain member, be sure to specify both the user name and the domain
in the standard Microsoft syntax. For example: DOMAIN\Administrator.
Remote WMI connections use RPC as a communications interface. If the RPC service is disabled on the
target server, remote WMI connections cannot be established.
Configure Distributed Component Object Model (DCOM) and User Account Control (UAC)
If the target computer is running Windows Vista or Windows Server 2008, you may be required to make
settings changes to allow remote WMI requests (http://msdn.microsoft.com/en-us/library/aa822854
(VS.85).aspx).
Item Need
1305
n Default and Limits permissions edited to allow the following actions:
WMI n Modify the CIMV2 security to enable and remote enable the account used to access
Namespaces the server or workstation through WMI. You must ensure the security change
applies to the current namespace and sub-namespaces.
User n Remote UAC access token filtering must be disabled when monitoring within a
Account workgroup environment.
Control
WMI uses DCOM to communicate with monitored target computers. Therefore, for Server & Application
Monitor to use WMI, DCOM must be enabled and properly configured.
The account you specify in the Credentials Library must possess security access to the namespace and
sub-namespaces of the monitored target computer.
1306
4. Select the Security tab, and then expand Root and click CIMV2.
5. Click Security and then select the user account used to access this computer and ensure you grant
the following permissions:
Enable Account
Remote Enable
6. Click Advanced, and then select the user account used to access this computer.
7. Click Edit, select This namespace and subnamespaces in the Apply to field, and then click OK.
8. Click OK on the Advanced Security Settings for CIMV2 window.
9. Click OK on the Security for Root\CIMV2 window.
10. Click Services in the left navigation pane of Computer Management.
11. Select Windows Management Instrumentation in the Services result pane, and then click Restart.
If you are monitoring a target in a workgroup, you need to disable remote User Account Control (UAC). This
is not recommended but it is necessary when monitoring a workgroup computer. Disabling remote user
account control does not disable local user account control functionality.
Warning: The following procedure requires the modification or creation of a registry key. Changing
the registry can have adverse effects on your computer and may result in an unbootable system.
Consider backing up your registry before making these changes.
1. Log on to the computer you want to monitor with an administrator account.
2. Click Start > Accessories > Command Prompt, then enter regedit.
3. Expand HKEY_LOCAL_
MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System.
4. Locate or create a DWORD entry named LocalAccountTokenFilterPolicy and provide a
DWORD value of 1.
If the target computer has Windows Firewall enabled, it must have a Remote WMI exception to allow
remote WMI traffic through (http://msdn.microsoft.com/en-us/library/aa389286(VS.85).aspx).
1. Click Start, click Run, type cmd and then press Enter.
2. At the command prompt, type netsh advfirewall firewall set rule group="Windows
Remote Management" new enable=yes, and then press Enter.
3. At the command prompt, type exit, and then press Enter.
1307
Determine if an additional polling engine is needed
Symptoms that may indicate you need an additional polling engine include, but are not limited to, the
following:
n Polling completion rates are lower than expected which leads to gaps in data.
n Sporadic component monitor timeouts usually resulting in component monitors showing an
"Unknown" status, reporting the error, "Connection timeout. Job cancelled by scheduler."
n Resource exhaustion on the SQL server.
For more information, see Additional Polling Engine and Web Console.
Make sure that the credential you are using for remote WMI is the same credential that you are using in
the SAM component. After you click Set Component Credentials to set the component credentials, you
must also click Submit at the bottom of the page.
There are various possibilities for this to occur. Read the following section to help troubleshoot this issue.
In APM v4 and higher, services can be polled via RPC or WMI. Ensure the correct service is running by
navigating to Edit Application > RPC or WMI.
1308
Repair the WMI Repository according to this KB article:
http://knowledgebase.solarwinds.com/kb/questions/633/Error+message+%22Invalid+Class%22+wh
en+using+WMI+monitors
Vista and Windows 2008 have a built-in method for repairing the WMI repository. Open an
Administrator command prompt and run: winmgmt /salvagerepository
1. Re-sync the counters by opening a command prompt and typing: winmgmt /resyncperf
2. Check to make sure performance counters are not disabled:
http://thwack.com/forums/68/application--server-management/21/application-performance-
monitor/23124/win32perfrawdataperfprocpro/
WMI is an operating system component. If the previous steps do no work, you may need to contact
Microsoft for further information.
This guide depicts only the most common scenarios that can cause WMI services to fail. If you are unable
to get WMI services to work at this point, it is time to consult Microsoft on this topic.
The SQL Server temporary directory, tempdb, where temporary database objects generated during table
creation and sorting are stored, is typically created in the same location on your Orion database server as
the master, model, and msdb databases. Moving the tempdb database to a physical drive separate from
your Orion database can significantly improve overall system performance.
For more information about moving the SQL Server 2008 temporary directory, tempdb, see "Moving
System Databases – Example A: Moving the tempdb Database".
Following established Windows standards, the SolarWinds Orion installer may use Windows User and
System TEMP and TMP variable directories as temporary scratch spaces for file expansion and execution. If
you do not have the required scratch space available in the default User or System TEMP and TMP
directories, use the following procedure to redefine your default locations.
Note: Regardless of where you actually install SolarWinds Orion, some common files may be installed
where the operating system of your Orion server are located.
1309
To redefine default system temporary directories:
Troubleshooting agents
The most common issues with agents occur during installation or configuration. The agent may be unable
to connect to the SolarWinds Orion server, or the server may be unable to connect to the agent.
For information about what a plug-in status means, see View the status of agent plug-ins.
If your agent does not deploy correctly, use the following questions to help you troubleshoot the issue. You
can also install the agent manually on the target computer.
n Some software installations, such as Windows Updates, prevent other installations from finishing
successfully.
n Install the agent when the other installations have completed.
n Deployment can fail when the computer is waiting to be restarted after installing software.
n Restart the computer and try again.
Is the SolarWinds agent server already installed and running on the target computer?
Can you ping the SolarWinds Orion server or connect to the web console from the target computer?
n You may have a network policy that interferes with deploying agents.
1310
Troubleshooting agent deployment
n Ensure that you can ping the Orion server from the client machine.
n Ensure that port 17778 is open on the Orion server and that the client machine can connect to it.
n Ensure that you are using the correct Orion administrator credentials.
n Ensure that the account can access and create a folder at the following location: \\<hostname_or_
ip>\admin$\temp
n Ensure that Remote Procedure Call (RPC), a Windows service, is running
n Ensure the required ports are open
n If you are using a domain account, use the complete name when entering credentials. For example:
domain\username
n Ensure there are no other installations in progress. For example, Windows updates prevent other
installations from finishing successfully. If this is the case, retry installing the agent after the other
installations complete.
n On the target machine, check if the SolarWinds Agent service is installed and running. If it is, the
agent may be experiencing connectivity issues with the Orion server. Ping the Orion server from the
client machine, and ensure that port 17778 is open on the Orion server. Ensure the client machine
can connect to the Orion server web console.
n Install the agent manually on the target machine, and set the permissions correctly.
Agent deployment can fail if a previous installation or upgrade is awaiting a reboot. To resolve
this issue, you must reboot the server before the agent installation can proceed.
n Install the agent manually on the target machine, ensuring that permissions are set correctly.
n If a host name or Fully Qualified Domain Name was used, ensure that it can be resolved from the
client computer.
n If the Orion server or the additional poller is behind a NAT, ensure that the IP address specified
when creating the MST file is the correctly routed IP address the client uses to access the Orion
server.
1311
Agent is not running in passive mode
n The agent is running in the agent-initiated communication mode and you cannot connect to it.
n Change the communication mode to server-initiated. You can uninstall and install the agent from the
server, or manually install it.
n You can change the communication mode on the remote host through the Control Panel > Orion
Agent Settings.
n The agent version is empty or zero. This indicates that something is wrong with the agent.
n Install the agent again.
If your agent and your SolarWinds Orion server cannot communicate, the agent cannot respond to queries
or the SolarWinds Orion server cannot receive data from the agent.
You must have access to the remote host for most troubleshooting steps.
n You can check the Manage Agents page for the agent status, or log in to the remote host with the
agent installed to check the status.
n If the agent is not running or has stopped, start the SolarWinds Agent service.
n Select the agent in the Manage Agents page and click More Actions > View installed agent plug-ins.
n If there is a problem with a plug-in, restart the agent. The agent checks for new plug-ins when it
restarts.
Do the communication modes match between the agent and the server?
n On the remote host, open the Control Panel > Orion Agent Settings. The communication mode must
match the communication mode in the Manage Agents page on the SolarWinds Orion server.
n If the modes do not match, change one to match the other.
1312
Does the agent initiate communication?
1313
Hardware troubleshooting flowchart
Dell does not make array and hard disk health information visible from WMI managed nodes. To
monitor storage health on Dell servers, use SNMP.
1314
Troubleshoot hardware health
If you can see that Orion Web Console does not display correct status information about your
sensors, consider changing the MIB tree used for polling your Cisco device. See Change MIB used for
polling hardware health statistics.
Temperature statistics can be displayed in degrees Celsius or Fahrenheit. See Change hardware
health temperature units.
When monitoring hardware health, there might be sensors which do not report values, just the
sensor status. These sensors cannot be displayed in charts because the data used for creating the
chart are missing.
Consider how often you need to poll the hardware statistics, and how long you need to archive them.
To improve the performance, poll for the statistics less frequently, or shorten the retention periods.
The most common issue customers face is that hardware information is not available via SNMP because
the Hardware Monitoring Agent software was installed before SNMP was installed. This means MIBs were
never installed and/or configured correctly. The easiest solution is to uninstall and then re-install the
Hardware Monitoring Agent software after installing SNMP on the server. If this is not the case, follow the
troubleshooting steps as outlined below:
1315
Verify the node was successfully added using SNMP
1. Verify the polling method on the Node Details page as shown below:
2. Verify the Hardware Monitoring Agent software is installed on the remote server and running.
3. Determine if SNMP responds for the proper OID. Below are the correct OIDS for each vendor:
For HP:1.3.6.1.4.1.232.2.2.2.1.0
For Dell:1.3.6.1.4.1.674.10892.1.300.10.1.8.1
For IBM:1.3.6.1.4.1.2.6.159.1.1.60.3.1
To determine if the remote server responds to the correct OID, you can use the MIB browser from
SolarWinds Engineer’s Toolset, which can be downloaded from http://www.solarwinds.com/downloads/.
Additionally, you can use other applications capable of making SNMP requests.
If you do not have a tool for checking OIDs on the remote server, you can create an SNMP walk by using the
SNMPWalk.exe installed with SAM, normally located at C:\Program Files (x86)
\SolarWinds\Orion\SnmpWalk.exe. SNMPWalk.exe is used in this demonstration.
Use SNMPWalk.exe
1316
1. Start SNMPWalk.exe and type in the IP address of the remote server and the community string for
SNMP.
2. Click Scan then save the SNMP walk in a text file.
3. Open the text file and manually search for the OIDs.
If the Remote Server does not respond on this OID, the Hardware Monitoring Agent software may not be
properly configured. Check to see if the Hardware Monitoring Agent software has imported the correct
MIBs as outlined in the following table.
HP Dell IBM
CPQIDA-MIB IBM-SYSTEM-LMSENSOR-MIB
CPQHLTH-MIB IBM-SYSTEM-MEMORY-MIB
CPQSTSYS-MIB IBM-SYSTEM-POWER-MIB
CPQIDE-MIB IBM-SYSTEM-PROCESSOR-MIB
IBM-SYSTEM-RAID-MIB
ADAPTEC-UNIVERSAL-STORAGE-MIB
The following conditions must be met before you can proceed troubleshooting WMI nodes:
1317
5. Enter administrator credentials and click Connect.
6. Once connected, click Query… from the main screen. The Query dialog appears.
7. Enter: select * from __Namespace
1318
10. Run a Query for specific information:
Select Manufacturer, Model, SerialNumber from CIM_Chassis
11. If the test was not successful, re-install the platform or Hardware Monitoring Agent software on the
remote server with the latest release.
VMWare nodes can be polled for Hardware information either through the vCenter or directly by using the
CIM protocol. Polling through the vCenter uses VMWare's native API interface. Polling the ESX server
directly uses the CIM protocol to get Hardware information.
You may need to log in with an administrator account to perform this action.
1319
3. Use the illustration below to determine how your VMWare is being polled.
If the following conditions cannot be met, the Hardware Health resources will not be displayed. To monitor
hardware in SAM, the following must be true:
n The monitored node must be HP Proliant, Dell PoweEdge, IBM X-Series, HP C7000, HP C3000, or Dell
M1000e.
n The node must be monitored using one of the following protocols:
n SNMP
n WMI
n ICMP nodes are allowed for VMWare when the Poll for VMware option is selected.
l The Hardware Monitoring Agent software, (provided by the vendor), is installed on the remote server.
This applies for both SNMP and WMI. Required software can be found at "Monitoring Hardware
Health".
l For VMware, the minimum requirements are as follows: ESX server version 3.5, 4.0, 4.1, ESXi version
5.0, vCenter version 4.0, 4.1, 5.0.
The following systems have been verified to work properly with SAM's hardware monitoring
features.
Other systems may work as well.
n Dell PowerEdge M610, R210, R610, R710, R900, 1950, 2850, 2950, 2970, 6850
n HP ProLiant DL320 G4, DL360 G3, DL360 G4, DL380 G4, DL380 G6, ML570 G3
n IBM IBM System x3550, System x3550 M2, System x3550 M3, System x3650, System x3650 M2, System
x3650 M3, x3850, eServer 306m
n HP C7000, HP C3000
n Dell M1000e.
1320
IBM's ServeRAID Manager software must be installed on IBM X-Series servers for storage hardware
health information to be displayed in SolarWinds SAM. HP’s WBEM providers are required for HP
servers polled via WMI.
n Troubleshoot permissions
n Troubleshoot Exchange performance counters
n Troubleshoot error codes in AppInsight for Exchange
Important: The following log file contains all the information and errors related to the WinRM
configuration process:
C:\ProgramData\Solarwinds\Logs\APM\RunWinRMConfigurator.log
Troubleshoot permissions
The following information helps you troubleshoot issues with the following:
n Non-Domain Accounts
n Adding Local Administrative privileges to Active Directory Account
n Exchange Access
n Mailbox Exchange Access
Mailboxes with an empty primary SMTP address can be polled; however, their Sent and Received
statistics are not available.
Non-Domain Account
Local accounts (Non-Domain) cannot access Exchange Management interfaces and therefore are not
supported by AppInsight for Exchange. Please select an Active Directory account or create a new one to
use with AppInsight for Exchange.
1. On the server where you wish to grant local administrative privileges, open a Computer Management
console.
Note: On Windows 2012, add this privilege using the Active Directory console.
2. Navigate to the Administrators group.
3. Add the type in the Active Directory user name of the account you want to grant administrative
privileges. (Ensure the location is set to either the domain where the account is located or Entire
Directory.)
4. Save your changes.
1321
Alternatively, you can add an Active Directory group to the local administrators group and add the
Active Directory user accounts to that group.
To verify the account and local group membership has been configured properly, run the
following in a PowerShell session
$Recurse = $true
$GroupName = 'Administrators'
Add-Type -AssemblyName System.DirectoryServices.AccountManagement
$ct = [System.DirectoryServices.AccountManagement.ContextType]::Machine
$group =
[System.DirectoryServices.AccountManagement.GroupPrincipal]::FindByIdentity
($ct,$GroupName)
$LocalAdmin = $group.GetMembers($Recurse) | select @{N='Domain'; E=
{$_.Context.Name}}, samaccountName, @{N='ObjectType'; E=
{$_.StructuralObjectClass}} -Unique
$LocalAdmin = $LocalAdmin | Where-Object {$_.ObjectType -eq "user"}
Exchange Access
Granting Least Privilege access to the Exchange Organization can be accomplished using Active Directory
Users and Computers (ADUC)
1. From the Start Menu, open ADUC and navigate to the Microsoft Exchange Security Groups OU.
2. Double click on the View-Only Organization Management group. After the window opens, click the
Members tab and then click Add.
1322
3. Type the user name of the account you want to grant access to the Exchange organization, and then
click OK.
4. Click Apply and then click OK, then close the ADUC window.
Access can also be granted using the Exchange Management Shell with the following
command
Replace the word "user" with the correct user name of the service account.
To verify the management role is properly assigned, use the following commands:
or
Mailbox Search access is required to determine attachment counts and sizes. It can be granted using the
Exchange Management Shell (EMS).
To verify the management role has been properly assigned, use the following
command:
Exchange Management Roles can be assigned to role assignees using either regular or
delegating role assignments.
n Regular role assignments enable the role assignee to access the permissions provided
by the management role entries on this role.
n Delegating role assignments give the role assignee the ability to assign this role to Role
Groups, Users, or Universal Security Groups.
1323
Troubleshoot Exchange performance counters
Occasionally, you may encounter an Exchange server which is missing some of the expected performance
counters. If this happens, you need to verify whether the counters are simply disabled or if they are
completely missing. The simplest way to do this is through the registry.
Warning: The following procedure requires modification to the registry and should be approached
with caution. It is highly recommended that you backup the registry before performing this
procedure. For instructions on backing up the registry, visit www.microsoft.com.
1. From the Registry editor, navigate to the service with the missing performance counters.
Note: Individual services are listed under HKLM\SYSTEM\CurrentControlSet\Services.
2. Expand the service and click on the Performance key. The important values we want to ensure exist
are listed below and displayed in Figure 1.
[HKEY_LOCAL_
MACHINE\SYSTEM\CurrentControlSet\Services\<ServiceName>\Performance]
Example: [HKEY_LOCAL_
MACHINE\SYSTEM\CurrentControlSet\Services\ESE\Performance]
"Close"="ClosePerformanceData"
"Collect"="CollectPerformanceData"
"Open"="OpenPerformanceData"
Example:"PerfIniFile"="eseperf.ini"
Figure 1.
1324
3. Verify the counters have not been disabled by expand the service and then clicking on the
"Performance" key.
4. Check for the value, Disable Performance Counters (See Figure 2.) If this value exists, ensure the data
value is 0. Any other value disables the counters.
5. Once the value is confirmed to be set to 0, close all PerfMon windows and then reopen them.
Note: The performance counters should be visible at this time. If the performance counters are not
visible, proceed to the next step.
Figure 2.
6. If the values First Counter, First Help, Last Counter, and Last Help are listed (See Figure 3), it is
highly recommended to unload the performance counters prior to reloading them.
Figure 3.
1325
Unload performance counters: (See Figure 4)
1. Close all Performance Monitor windows and stop any services which may be using these counters.
2. Open the Exchange Management Shell (EMS) in the Run as Administrator context.
3. Type: Add-PSSnapin Microsoft.Exchange.Management.PowerShell.Setup and then press
Enter.
4. Type: Remove-PerfCounters -DefinitionFileName "<Path to counter definition
XML file> and then press Enter.
a. The default location for Exchange counter definition files is: C:\Program
Files\Microsoft\Exchange
Server\%ExchangeVersion%\Setup\perf\%XMLFileName%
1. Close all Performance Monitor windows and stop any services which may be using these counters.
2. Open the Exchange Management Shell (EMS) in the Run As Administrator context.
3. Type: Add-PSSnapin Microsoft.Exchange.Management.PowerShell.Setup and then
press Enter.
4. Type: New-PerfCounters -DefinitionFileName "<Path to counter definition XML
file> and then press Enter.
a. The default location for Exchange counter definition files is: C:\Program
Files\Microsoft\Exchange
Server\%ExchangeVersion%\Setup\perf\%XMLFileName%
5. Check the application log to verify the counters were properly loaded and no PerfLib errors exist.
Reopen PerfMon to ensure the counters are available.
Figure 4.
1326
Troubleshoot error codes in AppInsight for Exchange
Following are the possible error messages associated with AppInsight for Exchange. Included are possible
causes and solutions.
The following log file contains all the information and errors related to the WinRM configuration
process: C:\ProgramData\Solarwinds\Logs\APM\RunWinRMConfigurator.log
Configuration Errors
Error message: Remote configuration was unsuccessful due to the following: "The deployment service
executable was not found on the Orion server." For details, see the log on the Orion server:
([ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Description: Internal error. The Remote Installation Service.exe file was not found. (Default
file location: C:\Program Files (x86)\SolarWinds\Orion\APM). This can be caused by an
incorrect SAM installation or Remote Installation Service.exe was deleted or modified.
Remediation: Add the Remote Installation Service.exe file to the following folder:
C:\Program Files (x86)\SolarWinds\Orion\APM.
Error message: Remote configuration was unsuccessful due to the following: "Failed to start Windows
Remote Management" For details, see the log on the Orion server: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Remediation:
1. On the target Exchange server, navigate to the Windows Services console and find the Windows
Remote Management (WS-Management) service.
2. Set Startup type to Automatic.
3. Start the Windows Remote Management (WS-Management) service.
Resolution: Try enabling this feature manually by taking the following steps:
1327
5. When complete, rerun the AppInsight for Exchange Automatic Configuration Wizard.
Error message: Remote configuration was unsuccessful due to the following: "The configurator
executable was not found on the Orion server." For details, see the log on the Orion server:
([ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Error message: Remote configuration was unsuccessful due to the following: "Access denied." For
details, see the log on the Orion server: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Description: The provided user account does not have access to the Administrator share on the remote
Exchange server.
Error message: Remote configuration was unsuccessful due to the following: "The configurator
executable has an invalid signature." For details, see the log on the Orion server: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Description: The configuration executable cannot be started on the remote Exchange server due to any
of the following:
Remediation:
1328
Error message: Remote configuration was unsuccessful due to the following: "The network path was not
found." For details, see the log on the Orion server: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Remediation:
n Firewalls can block traffic to the network which could generate this message. Try temporarily
disabling any software or hardware firewalls to isolate the problem.
n Anti-spyware tools can block network traffic. Try temporarily disabling any anti-spyware programs
and restart the computer to isolate the problem.
Error message: Remote configuration was unsuccessful due to the following: "Executable configuration
file was not found on the Orion server." For details, see the log on the Orion server:
([ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
Error message: Remote configuration was unsuccessful due to the following: "PowerShell 2.0 was not
detected on the Exchange server." Learn how to correct this. For details, see the log on the remote
computer. ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RunWinRMConfigurator.log).
For Server 2008, download the installation file for PowerShell 2.0 at
http://support.microsoft.com/kb/968929/en-us and install it on the server.
1329
Install PowerShell 2.0 on Server 2012
Error message: Remote configuration was unsuccessful due to the following: "This account must be an
Active Directory account with local administrative privileges." Learn how to correct this. For details, see
the log on the remote computer. ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RunWinRMConfigurator.log).
Description: The provided user account does not have Local Administrative privileges.
Remediation:
1. On the server where you wish to grant local administrative privileges, open a Computer
Management console.
Note: On Windows 2012, add this privilege using the Active Directory console.
2. Navigate to System Tools > Local Users and Groups > Groups and double click the Administrators
group.
3. Click Add and type in the Active Directory user name of the account you want to grant
administrative privileges, and then press Enter. (Ensure the location is set to either the domain
where the account is located or Entire Directory.)
4. Click Apply and then click OK.
Note: Alternatively, you can add an Active Directory group to the local administrators group and
add the Active Directory user accounts to that group.
Error message: Remote configuration was unsuccessful due to the following: "This account must be an
Active Directory account with organization wide Exchange access (View-Only-Organization Management
and Mailbox Search Management Role)." Learn how to correct this. For details, see the log on the remote
computer. ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RunWinRMConfigurator.log).
1330
Description: The provided user account does not have View-Only-Organization Management or Mailbox
Search Management privileges.
Remediation:
Granting Least Privilege access to the Exchange Organization can be accomplished using Active Directory
Users and Computers (ADUC). To accomplish this, take the following steps:
1. From the Start Menu, open ADUC and navigate to the Microsoft Exchange Security Groups OU.
2. Double click on the View-Only Organization Management group.
3. After the window opens, click the Members tab and then click Add.
4. Type the user name of the account you want to grant access to the Exchange organization, and
then click OK.
5. Click Apply, and then click OK.
6. Close the ADUC window.
Mailbox Search access is required to determine attachment counts and sizes. This can be granted using
the Exchange Management Shell (EMS).
Error message: Remote configuration was unsuccessful due to the following: "An error occurred during
Exchange Server Confiduration. Multiple connections to a server or shared resource by the same user,
using more than one user name, are not allowed."
Cause: This is a Windows Limitation when trying to map multiple drives to the same computer using
different user accounts.
Resolution:
1331
Error message: Remote configuration was unsuccessful due to the following: "WinRM test was
successful. PowerShell Exchange web site testing failed with the following error: Connecting to remote
server..."
Description: There are no default HTTPS bindings for all unassigned ports, (i.e. “HTTPS 443 *”.)
Remediation: Establish the missing default HTTPS binding with an Exchange certificate.
1332
Access is denied when configuring AppInsight for IIS
Issue: You may encounter access denied errors when you choose not to use the built-in administrator
account for IIS polling. This can occur if you create a new user and then add this user to the
Administrator's group.
Cause: If the group policy or the local policy has Administrator Approval Mode set to Enable, the polling
fails with an error. This is usually because the administrator account does not have enough permissions.
Resolution:
1. In your local security policy, navigate to Local Policies > Security Options > User Account Control: Run
all administrators in Admin Approval Mode.
Note: This should be set to Disabled to let administrators poll properly.
2. Navigate to Local Policies > Security Options > User Account Control: Admin Approval Mode for the
Built-in Administrator Account.
Note: This should be Disabled for the built-in administrator to poll properly.
3. When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Using AppInsight applications with 32-bit polling on 64-bit computers via an agent prevents certain
performance counters from collecting information and should be changed to 64-bit polling.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click My Dashboards > Applications > SAM Summary.
2. Select an AppInsight Application (Exchange, SQL, IIS) and then click Edit Application Monitor.
3. Expand Advanced, and then click Override Template.
4. In the Platform to run polling job field, change the value to x64.
5. Click Submit.
You may need to log in with an administrator account to perform this action.
1. On the Web Console, click Settings > All Settings > SAM Settings > Manage Templates.
2. Select an AppInsight application and click Edit.
1333
3. Expand Advanced, and in the Platform to run polling job on field, change the value to x64.
Error: The credentials given are not valid. Please provide the correct credentials for an account with WMI
permissions.
Issue: You receive an error similar to the following: The SSL connection cannot be established. Verify that
the service on the remote host is properly configured to listen for HTTPS requests.
Resolution: Manually remove the existing PowerShell listener and re-run the IIS configuration wizard. This
process creates a new listener along with the appropriate certificate needed.
IIS polling failed
1334
Cause: This is a general error message returned by Windows when a networking component is
malfunctioning.
Resolution: For details, see the log on the Orion server located at: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log). Following are some of
the more common reasons why this error message might be returned by Windows:
For example: Restart the remote registry service, check that TCP port 445 is open between the Orion
server and the remotely monitored IIS server.
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Node unreachable
Resolution: Ensure the node is currently being managed. For more information, see Schedule tasks to be
stopped using the Unmanage Scheduling utility. When complete, rerun the AppInsight for IIS Automatic
Configuration Wizard.
IIS version failed
Error: The current version of IIS is 6.0. Version 7.0 or higher is required.
Resolution: Install IIS version 7.0 or higher. When complete, rerun the AppInsight for IIS Automatic
Configuration Wizard.
Error: WinRM testing failed with the following error: Connecting to remote server failed with the following
error message: Access is denied.
Resolution: Set the appropriate permissions for PowerShell on the target server. When complete, rerun
the AppInsight for IIS Automatic Configuration Wizard.
Resolution: Enter a valid user name and password combination. When complete, rerun the AppInsight for
IIS Automatic Configuration Wizard.
1335
Error code 1726
Cause: This can be due to a temporarily slow network or a heavily taxed computer at the moment of
configuration causing the remote installer not to receive the necessary exit codes. Configuration is most
likely successful at this point and the displayed error message is simply a response to the exit codes not
being returned.
Resolution: Running the configuration wizard again or clicking, I've already manually configured this
server under Advanced should result in a successful configuration.
Error: The deployment service executable was not found on the Orion server.
Cause: The Remote Installation Service.exe file was not found. This could be caused by an
incorrect SAM installation or the Remote Installation Service.exe was deleted or modified.
Resolution: Add the Remote Installation Service.exe file to the following directory: C:\Program
Files (x86)\SolarWinds\Orion\APM. For details, see the log on the Orion server located at:
([ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Error: The configuration executable was not found on the Orion server.
Cause: The SolarWinds.APM.RemoteIISConfigurator.exe file was not found. This can be caused
by an incorrect SAM installation or the SolarWinds.APM.RemoteIISConfigurator.exe file was
deleted or modified.
1336
Error code 16006
Cause: The provided user account does not have access to the Administrator share on the remote IIS
server.
Resolution: Ensure the provided user account has access to the Administrator share by trying to connect
to the Administrator share with the following: \\IISComputerName\<drive letter>$\ from the Orion
server. When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Cause: The configuration executable cannot be started on the remote IIS server due to one or more of the
following:
Resolution: Try to lower the User Account Control settings on remote IIS server. Also check that the user
account has privileges to run executable files. When complete, rerun the AppInsight for IIS Automatic
Configuration Wizard.
Cause: This is a general error message returned by Windows when a networking component is
malfunctioning. This may be caused by not having the appropriate root or intermediate certificate on the
remote IIS server.
Resolution: For details, see the log on the Orion server located at: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log). Following are some of
the more common reasons why this error message might be returned by Windows:
n Ensure you have access to the shared storage drive. When complete, rerun the AppInsight for IIS
Automatic Configuration Wizard.
n Firewalls can block traffic to the network which could generate this message. Try temporarily
disabling any software or hardware firewalls to isolate the problem. When complete, rerun the
AppInsight for IIS Automatic Configuration Wizard.
n Like firewalls, some anti-spyware tools have the same effect. Try temporarily disabling any anti-
spyware programs and restart the computer to isolate the problem. When complete, rerun the
AppInsight for IIS Automatic Configuration Wizard.
1337
Error code 16009
Error: The configuration file for the configuration executable was not found on the Orion server.
Cause: This is an internal error. This can be caused by either an incorrect SAM installation, or the
SolarWinds.APM.RemoteIISConfigurator.exe.config file was deleted or modified.
([ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteExecutableStarter.log).
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Resolution: Try enabling this feature manually by taking the following steps:
Cause: This error means that an HTTPS listener already exists on port 5986 and cannot be reused because
it is not configured to listen for the target IIS server IP address.
Resolution: For details, see the log on the target computer located at: ([ALLUSERSPROFILE]
\ProgramData\Solarwinds\Logs\APM\RemoteIISConfigurator.log &
RemoteIISConfiguratorPowerShell.log). For configuring WinRM using a different port, see
WinRM 2.0
Resolution: Check the configuration script log file located on target the IIS server, located at
[ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteIISConfigurator.log.
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
1338
Error code 16024
Cause: This error means that an unexpected error occurred during wsMan listener creation.
Resolution: Check the configuration script log file located on the target IIS server at,
[ALLUSERSPROFILE]\ProgramData\Solarwinds\Logs\APM\RemoteIISConfigurator.log.
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Cause: This error means that the Windows Remote Management (WS-Management) service cannot be
started remotely.
Resolution: Ensure the Windows Remote Management service is running on the target IIS server.
Resolution: For more information, see Other errors. Once the problem is isolated, rerun the AppInsight
for IIS Automatic Configuration Wizard.
Resolution: Ensure that PowerShell 2.0 or higher is installed on the target server. When complete, rerun
the AppInsight for IIS Automatic Configuration Wizard.
For Windows Server 2008, download the installation file for PowerShell 2.0 at
http://support.microsoft.com/kb/968929/en-us and install it on the target server.
PowerShell 2.0 is automatically installed on Windows Server 2008 R2 and therefore no additional
installation is required.
Other errors
For Server 2008, download the installation file for PowerShell 2.0 at
http://support.microsoft.com/kb/968929/en-us and install it on the server.
1339
PowerShell 2.0 is automatically installed on Server 2008 R2 and therefore no additional
installation is required.
Information: For legacy systems with IIS 7.0 (Windows Vista, Windows 2008) PowerShell
WebAdministration snapins are not part of IIS.
Resolution: Download and install the PowerShell WebAdministration snapins found at the following link:
http://www.iis.net/downloads/microsoft/powershell
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
Possible Errors: OutOfMemoryException, Not enough storage, WinRM, WinRM not functioning properly,
and so on.
Cause: IIS servers hosting many sites may cause polling to be unsuccessful.
Resolution: Increase the polling frequency and Memory per Shell Limit on the target node as needed.
When complete, rerun the AppInsight for IIS Automatic Configuration Wizard.
The default value is set at 300 seconds (five minutes). If you see more than a five minute gap in a graphed
resource, this value can be increased, as in any other SAM application.
1. Click My Dashboards > SAM Summary, and then select an application to be taken to the Application
details page.
2. Click Edit Application Monitor > Override template (next to Polling Frequency).
3. Change to the desired value, and then click Submit.
1. Run PowerShell via Run as Administrator and execute the following command to get the actual value:
winrm get winrm/config/Winrs
1340
2. Examine MaxMemoryPerShellMB. If the value is less than 512, increase this value by executing
the following command:
Set-Item WsMan:\localhost\Shell\MaxMemoryPerShellMB NewValue -WarningAction
SilentlyContinue;
where the NewValue is the desired memory limit. If the error persists, the value should be
increased again.
Event IDs
The matrix below outlines and defines Microsoft event IDs to help aid in troubleshooting:
2297 Microsoft- Application Warning Worker process for application pool encountered
Windows- an error while trying to read global module
IIS- configuration
W3SVC-
WP
5015 Microsoft- System Warning Worker process serving application pool was
Windows- orphaned
WAS
5127 Microsoft- System Warning Worker process serving the application pool is no
Windows- longer trusted by Windows Process Activation
WAS Service (WAS)
1173 Microsoft- System Error World Wide Web Publishing Service did not
Windows- initialize the HTTP driver and was unable start
IIS-W3SVC
1026 Microsoft- System Warning World Wide Web Publishing Service encountered
Windows- an error when it tried to secure the handle of the
IIS-W3SVC application pool
1341
1135, 1134 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- configure the centralized World Wide Web
IIS- Consortium (W3C) logging properties
WMSVC
1020 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- configure the HTTP.SYS control channel property
IIS-
WMSVC
1062 Microsoft- System Warning World Wide Web Publishing service failed to
Windows- configure the logging properties for the HTTP
IIS- control channel
WMSVC
1126 Microsoft- System Warning World Wide Web Publishing Service failed to copy
Windows- a change notification for processing
IIS-W3SVC
1175 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- enable end point sharing for the HTTP control
IIS-W3SVC channel
1071, 1073 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- enable global bandwidth throttling
IIS-W3SVC
1087 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- properly configure the application pool queue
IIS-W3SVC length
1086 Microsoft- System Warning World Wide Web Publishing Service failed to
Windows- properly configure the load balancer capabilities
IIS-W3SVC on application pool
5067 Microsoft- System Warning World Wide Web Publishing Service property
Windows- failed range validation
WAS
1037 Microsoft- System Warning HTTP control channel for the World Wide Web
Windows- Publishing Service did not open
IIS-W3SVC
1342
2208 Microsoft- Application Warning HTTP Server could not create a client connection
Windows- object for user
IIS-
WMSVC
2206 Microsoft- Application Warning HTTP Server could not create the main connection
Windows- socket
IIS-
WMSVC
2201 Microsoft- Application Warning HTTP Server could not initialize its security
Windows-
IIS-
WMSVC
2203 Microsoft- Application Warning HTTP Server could not initialize the socket library
Windows-
IIS-
WMSVC
2204 Microsoft- Application Warning HTTP Server was unable to initialize because of a
Windows- shortage of available memory
IIS-
WMSVC
5088, 5061, Microsoft- System Warning Job object associated with the application pool
5060 Windows- encountered an error
WAS
2227 Microsoft- Application Warning The server was unable to acquire a license for an
Windows- SSL connection
IIS-
WMSVC
2233 Microsoft- Application Warning The server was unable to allocate a buffer to read
Windows- a file
IIS-
WMSVC
1343
2226, 2230, Microsoft- Application Warning The server was unable to read a file
2231, 2232 Windows-
IIS-
WMSVC
5174, 5179, Microsoft- System Warning Windows Process Activation Service (WAS)
5180 Windows- detected invalid configuration data
WAS
5085 Microsoft- System Warning Windows Process Activation Service (WAS) did not
Windows- apply configuration changes to application pool
WAS
5054, 5091 Microsoft- System Error Windows Process Activation Service (WAS) did not
Windows- run the automatic shutdown executable for
WAS application pool
5172, 5173 Microsoft- System Warning Windows Process Activation Service (WAS)
Windows- encountered an error trying to read configuration
WAS
5101 Microsoft- System Error Windows Process Activation Service (WAS) failed
Windows- to create application pool
WAS
1344
5070, 5093 Microsoft- System Warning Windows Process Activation Service (WAS) failed
Windows- to issue recycle request to application pool
WAS
2295 Microsoft- Application Warning Module registration error detected (failed to find
Windows- RegisterModule entry point)
IIS-
W3SVC-
WP
1133 Microsoft- System Warning Only one type of logging can be enabled at a time
Windows-
IIS-W3SVC
5036 Microsoft- System Error The configuration manager for Windows Process
Windows- Activation Service (WAS) did not initialize
WAS
1345
2264 Microsoft- Application Warning The directory specified for caching compressed
Windows- content is invalid
IIS-
WMSVC
2218 Microsoft- Application Warning The HTTP server encountered an error processing
Windows- the server-side include file
IIS-
WMSVC
2258 Microsoft- Application Warning The server failed to close client connections to
Windows- URLs during shutdown
IIS-
WMSVC
5010, 5011, Microsoft- System Warning Application pool worker process is unresponsive
5012, 5013 Windows-
WAS
2216 Microsoft- Application Warning A script has not responded within the configured
Windows- time-out period
IIS-
WMSVC
1346
2222 Microsoft- Application Warning An attempt was made to load an ISAPI filter on a
Windows- server instance, but because it requires the SF_
IIS- NOTIFY_READ_RAW_DATA filter notification, it
W3SVC- must be loaded as a global filter
WP
500, 499, 23, Active Application Warning ASP application error occurred
22, 21, 20, 19, Server
18, 17, 16, 9, 8, Pages
7, 6, 5
2279, 2278, Microsoft- Application Warning Worker process encountered an error during
2277 Windows- initialization
IIS-
W3SVC-
WP
WinRM 2.0
Important: If you received the following error: An HTTPS listener currently exists on port 5986, use
the following steps to configure the listener on an available port by changing 5986 to an available
port number throughout these steps.
1347
1. To configure WinRM on a server, open a command prompt in the Run as Administrator context.
2. Type: winrm create winrm/config/listener?Address=*+Transport=HTTPS @
{Port="5986";CertificateThumbprint="<Thumbprint value of
certificate>";Hostname="<IP Address of Server>_Solarwinds_IIS_Zero_
Configuration"} and then press Enter.
function Add-FirewallRule {
param(
$name,
$tcpPorts,
$appName = $null,
$serviceName = $null
)
$fw = New-Object -ComObject hnetcfg.fwpolicy2
$rule = New-Object -ComObject HNetCfg.FWRule
$rule.Name = $name
if ($appName -ne $null) { $rule.ApplicationName = $appName }
if ($serviceName -ne $null) { $rule.serviceName = $serviceName }
$rule.Protocol = 6 #NET_FW_IP_PROTOCOL_TCP
$rule.LocalPorts = $tcpPorts
$rule.Enabled = $true
$rule.Grouping = "@firewallapi.dll,-23255"
$rule.Profiles = 7 # all
$rule.Action = 1 # NET_FW_ACTION_ALLOW
$rule.EdgeTraversal = $false
$fw.Rules.Add($rule)
}
1348
3. Run the function to create the firewall exception for WSMAN using the following command:
Add-FirewallRule "Windows Remote Management" "5986" $null $null
4. Verify the rule was created by navigating to Control Panel > Windows Firewall > Advanced Settings.
Error message: If the ESX server returns the message, Unable to establish session with all provided
credentials, check the following:
There has been no statistically significant deviation of the collected metric during the baseline
period. Without some variance in the polled value, it is not possible to determine a valid warning or
critical threshold. For example if you poll Disk I/O statistics on an inactive volume, the value is always
zero and there is no way to statistically know whether 1 is bad, or if 1.000.000 is still good.
1349
The recommended warning or critical thresholds are less then minimum value for the statistic
This occurs when the Less Than, Greater Than operators are changed, but the values are not
updated. For example, when you have a Greater Than operator, the warning threshold cannot be
greater than the critical threshold. The inverse is true for the Less Than operator.
1350